1---2name: codebase-documenter3version: 1.0.04allowed-tools:5 - Read6 - Write7 - Edit8 - Glob9 - Grep10description: "Scaffold project documentation (README, ARCHITECTURE, API, CODE_COMMENTS) from templates with documented standards. Use when bootstrapping docs for a new or under-documented codebase."11license: MIT12metadata:13 source: https://skillmd.com/skills/rjmurillo/codebase-documenter14---1516# Codebase Documenter1718Generate 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.1920## Triggers2122| Trigger Phrase | Operation |23|----------------|-----------|24| `scaffold project documentation` | Generate README, ARCHITECTURE, API, code comment scaffolds |25| `bootstrap docs for new codebase` | Produce starter docs with placeholders |26| `add starter README` | Create README scaffold only |27| `set up documentation standards` | Drop standards references into the repo |28| `document this codebase from scratch` | Full scaffold pass |2930## When to Use3132Use this skill when:3334- A repository has no `README.md`, `ARCHITECTURE.md`, or API reference, and you need a populated skeleton.35- A team is onboarding without a tech writer and wants documented standards alongside the templates.36- You need a starting point for code-comment conventions in a polyglot project.3738Use a different skill when:3940- 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.41- You want narrative prose generated for an existing component. Use the `explainer` agent.4243## Boundaries4445- Writes scaffolding and standards references only. Does not write narrative prose for the project.46- Placeholders use bracket convention `[Like this]` so a writer can search and replace.47- Templates must be filled in by a human or downstream skill. The skill does not infer project specifics.4849## Process50511. Confirm the target directory and confirm no overwrite of existing docs without explicit user consent.522. Copy `assets/templates/README.template.md` to `README.md` (or path the user requests).533. Copy `assets/templates/ARCHITECTURE.template.md` to `ARCHITECTURE.md` if a separate architecture doc is wanted.544. Create parent directories (`docs/`, `docs/standards/`, or any user-requested path) before any copy step that targets them.555. Copy `assets/templates/API.template.md` to `docs/API.md` (or equivalent) if the project exposes an API.566. Copy `assets/templates/CODE_COMMENTS.template.md` to `docs/standards/CODE_COMMENTS.md` (or link from the README).577. Point the team at `references/documentation_guidelines.md` and `references/visual_aids_guide.md` for voice and visual standards.5859## Templates6061| Template | Purpose |62|----------|---------|63| `assets/templates/README.template.md` | Project front door. Why, quick start, structure, common tasks, troubleshooting. |64| `assets/templates/ARCHITECTURE.template.md` | System overview, components, data flow, decisions, failure modes. |65| `assets/templates/API.template.md` | API reference per endpoint with conventions and examples. |66| `assets/templates/CODE_COMMENTS.template.md` | Docstring and inline comment standards across languages. |6768## References6970| Reference | Purpose |71|-----------|---------|72| `references/documentation_guidelines.md` | Voice, structure, audience framing, placeholder convention. |73| `references/visual_aids_guide.md` | When and how to use diagrams, tables, callouts. |7475## Verification Checklist7677- [ ] No environment-specific paths in any template78- [ ] All user-provided paths are validated against path traversal79- [ ] Bracketed placeholders match the `[Word or short phrase]` convention80- [ ] Code fences are balanced and use language identifiers on the opener only81- [ ] Voice is active, audience is the project's reader (not the documenter)82- [ ] No marketing language, weasel words, or filler83- [ ] Diagrams added only when they reduce ambiguity (see `references/visual_aids_guide.md`)8485## Anti-Patterns8687| Avoid | Why | Instead |88|-------|-----|---------|89| Filling in placeholders speculatively | Produces fiction the team will rediscover and rewrite | Leave brackets; team fills in |90| Copying README content into ARCHITECTURE | Both files drift; readers cannot tell which is current | One concept per document |91| Adding diagrams for every section | Visual noise distracts from text | Diagram only where ambiguity is real |92| Long preamble before quick start | Readers leave before they reach the value | Quick start in the first screen |