Generate Level 1 (README.md) user documentation from design docs. Use when creating or updating package README files for npm/GitHub.
Generates Level 1 user documentation (README.md) from design docs and package metadata.
This skill transforms internal design documentation into a user-friendly package README by:
Generate README for a module:
/docs-generate-readme effect-type-registry
Update existing README preserving custom sections:
/docs-generate-readme rspress-plugin-api-extractor --update
Preview without writing:
/docs-generate-readme website --dry-run
module: Module name to generate README for [REQUIRED]--template: Custom template path (default: .claude/skills/docs-generate-readme/templates/readme.template.md)--dry-run: Preview output without writing--update: Update existing README preserving custom sectionsRead .claude/design/design.config.json to get:
Read module metadata:
package.json - name, version, description, license, dependenciesdesignDocsPath--update mode)Overview Section:
Features:
Quick Start:
API Overview:
Transform internal terminology to user-friendly language:
Fill the Level 1 template with extracted content:
New README mode (default):
Update mode (--update):
Dry-run mode (--dry-run):
Check generated README against quality standards:
When you need detailed information, load these files:
instructions.md - Detailed step-by-step implementationtransformation-rules.md - Content transformation guidelinesexamples.md - Example READMEs and transformationsquality-standards.md - Validation criteriaA generated README is successful when:
# Generate README for effect-type-registry
/docs-generate-readme effect-type-registry
# Output: pkgs/effect-type-registry/README.md created
# Content:
# - Title: effect-type-registry
# - Description: TypeScript type definition registry with caching
# - Features: Version-aware caching, HTTP retry, VFS generation
# - Quick start: 10-line working example
# - Links: API docs, contributing, license
.claude/design/design.config.json for module configuration.claude/skills/docs-generate-readme/templates/readme.template.md for structuredesignDocsPathpackage.json for metadatauserDocs.readme pathquality.userDocs.level1 standards/docs-sync - Sync README with design doc changes/docs-review - Review README quality/docs-generate-repo - Generate Level 2 repository docs/design-review - Review source design documentation