codebase-documenter

Solid

Scaffold project documentation (README, ARCHITECTURE, API, CODE_COMMENTS) from templates with documented standards. Use when bootstrapping docs for a new or under-documented codebase.

AI & Automation 38 stars 13 forks Updated today MIT

Install

View on GitHub

Quality Score: 80/100

Stars 20%
53
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Codebase Documenter Generate documentation scaffolding for a project that has none, or has the wrong shape. This skill produces structured starters with bracketed placeholders the team fills in. It does not write prose for you. ## Triggers | Trigger Phrase | Operation | |----------------|-----------| | `scaffold project documentation` | Generate README, ARCHITECTURE, API, code comment scaffolds | | `bootstrap docs for new codebase` | Produce starter docs with placeholders | | `add starter README` | Create README scaffold only | | `set up documentation standards` | Drop standards references into the repo | | `document this codebase from scratch` | Full scaffold pass | ## When to Use Use this skill when: - A repository has no `README.md`, `ARCHITECTURE.md`, or API reference, and you need a populated skeleton. - A team is onboarding without a tech writer and wants documented standards alongside the templates. - You need a starting point for code-comment conventions in a polyglot project. Use a different skill when: - Documentation already exists and you want to verify accuracy, detect missing XML docs / docstrings / JSDoc, or audit README / CLAUDE.md drift. Use `doc-accuracy` for verification, missing-doc detection, and structural sync. - You want narrative prose generated for an existing component. Use the `explainer` agent. ## Boundaries - Writes scaffolding and standards references only. Does not write narrative prose for the project. - Placeholders use bracket co...

Details

Author
rjmurillo
Repository
rjmurillo/ai-agents
Created
7 months ago
Last Updated
today
Language
Markdown
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category

Data & Documents Solid

codebase-documenter

Use this skill when the user wants to understand, document, or explain a codebase — even if they don't say "document" explicitly. Trigger on: "explain this codebase", "how does this project work", "create onboarding docs", "document the architecture", "I'm new to this repo", "generate a codebase overview", or any request to understand unfamiliar code. Produces a single docs/CODEBASE.md with architecture, components, data flow, setup instructions, and a recommended reading path for new developers. Supports quick/standard/deep depth levels and incremental updates.

5 Updated today
opencue
Data & Documents Solid

code-documenter

Expert documentation generator for coding projects. Analyzes codebases to create thorough, comprehensive documentation for developers and users. Supports incremental updates, multi-audience documentation, architecture decision records, and documentation health tracking. Works with any project type (APIs, CLIs, web apps, libraries). Use when you need to document a new project, update docs after adding features, or create comprehensive documentation for open source releases.

102 Updated 1 weeks ago
robertguss
Data & Documents Featured

codebase-documenter

Generates comprehensive documentation explaining how a codebase works, including architecture, key components, data flow, and development guidelines. Use when user wants to understand unfamiliar code, create onboarding docs, document architecture, or explain how the system works.

657 Updated 3 days ago
mhattingpete