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.

⭐5stars🔀1forks📁View on GitHub🕐Updated Jan 11, 2026⬇️1downloads

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.
namecreate-project-docs
descriptionCreates 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?
  1. Generate full documentation suite - README, CONTRIBUTING, CODE_OF_CONDUCT, CHANGELOG, architecture, API docs
  2. Generate a single document - Create or replace one specific document
  3. Update existing documentation - Refresh docs based on code changes
  4. 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
| Workflow | Purpose | |----------|---------| | generate-full-suite.md | Create complete documentation set | | generate-single-doc.md | Create one specific document | | update-docs.md | Refresh existing docs from code | | audit-docs.md | Check documentation completeness | Documentation is complete when: - All generated docs accurately reflect the codebase - README provides working quick-start example - Installation instructions are tested - API documentation covers all public interfaces - Styling is consistent across all documents - Links between documents work correctly