create-project-docs
创建全面的GitHub项目文档,包括README、CONTRIBUTING、CODE_OF_CONDUCT、CHANGELOG、架构文档和API文档。分析代码库以生成准确、样式良好且具有现代GitHub美学的文档。当设置新项目、改进现有文档或生成缺失文档时使用。
📖 中文导读:创建全面的GitHub项目文档,包括README、CONTRIBUTING、CODE_OF_CONDUCT、CHANGELOG、架构文档和API文档。分析代码库以生成准确、样式良好且具有现代GitHub美学的文档。当设置新项目、改进现有文档或生成缺失文档时使用。 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。
name: create-project-docs description: Creates comprehensive GitHub project documentation including README, CONTRIBUTING, CODE_OF_CONDUCT, CHANGELOG, architecture docs, and API documentation. Analyzes codebase to generate accurate, well-styled documentation with modern GitHub aesthetics. Use when setting up a new project, improving existing documentation, or generating missing docs.
Always analyze the actual codebase before writing documentation. Read source files, understand project structure, extract function signatures, and infer purpose from code. Never write documentation based on assumptions. All documentation follows modern GitHub conventions: - Badges at top of README (build status, version, license, coverage) - Table of contents for documents > 100 lines - Collapsible sections for verbose content using ``
- Emoji as section markers (use sparingly, consistently)
- Proper heading hierarchy (never skip levels)
- Code blocks with language identifiers
Every feature documented must include a working example. Examples should be:
- Copy-pasteable (complete, not snippets)
- Tested against actual codebase
- Ordered from simple to complex
Start with what users need most, hide complexity:
1. Installation (first 30 seconds)
2. Quick example (first 2 minutes)
3. Common use cases (first 10 minutes)
4. Advanced topics (when needed)
What would you like to document?
- Generate full documentation suite - README, CONTRIBUTING, CODE_OF_CONDUCT, CHANGELOG, architecture, API docs
- Generate a single document - Create or replace one specific document
- Update existing documentation - Refresh docs based on code changes
- Audit documentation - Check what's missing or outdated
Wait for response before proceeding.
| Response | Workflow | |----------|----------| | 1, "full", "suite", "all", "complete" | `workflows/generate-full-suite.md` | | 2, "single", "readme", "contributing", "one" | `workflows/generate-single-doc.md` | | 3, "update", "refresh", "sync" | `workflows/update-docs.md` | | 4, "audit", "check", "missing" | `workflows/audit-docs.md` |After reading the workflow, follow it exactly.
All domain knowledge in `references/`:Styling: github-styling.md (badges, emoji, collapsible sections, modern conventions) Document Types: doc-types.md (what each document should contain, best practices) Code Analysis: code-analysis.md (how to extract info from source files)
Output templates in `templates/`:| Template | Purpose |
|---|---|
| readme-template.md | Modern README with all sections |
| contributing-template.md | Contribution guidelines |
| code-of-conduct-template.md | Community standards |
| changelog-template.md | Version history format |
| architecture-template.md | System design documentation |
| api-docs-template.md | API reference format |