create-project-docs
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.
When & Why to Use This Skill
This Claude skill automates the creation of professional GitHub project documentation by performing deep codebase analysis. It ensures your project is well-documented from day one by generating accurate READMEs, API references, and architecture guides that follow modern GitHub aesthetics and best practices. By extracting information directly from source code, it eliminates the gap between implementation and documentation, making it an essential tool for developers and open-source maintainers.
Use Cases
- New Project Initialization: Quickly generate a complete documentation suite including README, CONTRIBUTING, and CODE_OF_CONDUCT to launch a professional-looking repository.
- Automated API Documentation: Analyze source files to extract function signatures and purpose, creating detailed API references that stay perfectly in sync with the code.
- Documentation Refresh: Update existing docs after major refactors or feature additions to ensure that installation steps and code examples remain functional and accurate.
- Documentation Audit: Scan a project to identify missing essential documents or outdated sections, providing a structured plan to improve project transparency and user onboarding.
| 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. |
- 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 |