1---2name: codebase-documenter-33description: "Scaffold project documentation (README, ARCHITECTURE, API, CODE_COMMENTS) from templates with documented standards. Use when bootstrapping docs for a new or under-documented codebase."4metadata:5 source: https://skillmd.com/skills/rjmurillo/codebase-documenter-36---78# Codebase Documenter910Generate 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.1112## Triggers1314| Trigger Phrase | Operation |15|----------------|-----------|16| `scaffold project documentation` | Generate README, ARCHITECTURE, API, code comment scaffolds |17| `bootstrap docs for new codebase` | Produce starter docs with placeholders |18| `add starter README` | Create README scaffold only |19| `set up documentation standards` | Drop standards references into the repo |20| `document this codebase from scratch` | Full scaffold pass |2122## When to Use2324Use this skill when:2526- A repository has no `README.md`, `ARCHITECTURE.md`, or API reference, and you need a populated skeleton.27- A team is onboarding without a tech writer and wants documented standards alongside the templates.28- You need a starting point for code-comment conventions in a polyglot project.2930Use a different skill when:3132- 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.33- You want narrative prose generated for an existing component. Use the `explainer` agent.3435## Boundaries3637- Writes scaffolding and standards references only. Does not write narrative prose for the project.38- Placeholders use bracket convention `[Like this]` so a writer can search and replace.39- Templates must be filled in by a human or downstream skill. The skill does not infer project specifics.4041## Process42431. Confirm the target directory and confirm no overwrite of existing docs without explicit user consent.442. Copy `assets/templates/README.template.md` to `README.md` (or path the user requests).453. Copy `assets/templates/ARCHITECTURE.template.md` to `ARCHITECTURE.md` if a separate architecture doc is wanted.464. Create parent directories (`docs/`, `docs/standards/`, or any user-requested path) before any copy step that targets them.475. Copy `assets/templates/API.template.md` to `docs/API.md` (or equivalent) if the project exposes an API.486. Copy `assets/templates/CODE_COMMENTS.template.md` to `docs/standards/CODE_COMMENTS.md` (or link from the README).497. Point the team at `references/documentation_guidelines.md` and `references/visual_aids_guide.md` for voice and visual standards.5051## Templates5253| Template | Purpose |54|----------|---------|55| `assets/templates/README.template.md` | Project front door. Why, quick start, structure, common tasks, troubleshooting. |56| `assets/templates/ARCHITECTURE.template.md` | System overview, components, data flow, decisions, failure modes. |57| `assets/templates/API.template.md` | API reference per endpoint with conventions and examples. |58| `assets/templates/CODE_COMMENTS.template.md` | Docstring and inline comment standards across languages. |5960## References6162| Reference | Purpose |63|-----------|---------|64| `references/documentation_guidelines.md` | Voice, structure, audience framing, placeholder convention. |65| `references/visual_aids_guide.md` | When and how to use diagrams, tables, callouts. |6667## Verification Checklist6869- [ ] No environment-specific paths in any template70- [ ] All user-provided paths are validated against path traversal71- [ ] Bracketed placeholders match the `[Word or short phrase]` convention72- [ ] Code fences are balanced and use language identifiers on the opener only73- [ ] Voice is active, audience is the project's reader (not the documenter)74- [ ] No marketing language, weasel words, or filler75- [ ] Diagrams added only when they reduce ambiguity (see `references/visual_aids_guide.md`)7677## Anti-Patterns7879| Avoid | Why | Instead |80|-------|-----|---------|81| Filling in placeholders speculatively | Produces fiction the team will rediscover and rewrite | Leave brackets; team fills in |82| Copying README content into ARCHITECTURE | Both files drift; readers cannot tell which is current | One concept per document |83| Adding diagrams for every section | Visual noise distracts from text | Diagram only where ambiguity is real |84| Long preamble before quick start | Readers leave before they reach the value | Quick start in the first screen |