← ClaudeAtlas

documentation-generatorlisted

Generate comprehensive documentation for a codebase by reading the repository and producing READMEs, API docs, architecture docs, and technical references. Use when the user asks to "document this repo", "generate docs", "write a README", "create API documentation", "document this codebase", "write architecture docs", or "produce technical references" for an existing project. NOT for UX copy, button labels, or interface microcopy (use ux-writing). NOT for pedagogical code examples or tutorials (use example-design). NOT for inline code comments. NOT for navigation or sitemap design (use navigation-design).
viktorbezdek/skillstack · ★ 9 · Data & Documents · score 76
Install: claude install-skill viktorbezdek/skillstack
# Repository Documentation Generator Generate documentation for repositories of any size - from a single README refresh to large monorepo documentation sets. Creates non-technical overviews, API docs, architecture docs, and technical references. Use the lightweight path for small README-only tasks. Use the full workflow when the user asks for a documentation set, codebase documentation, API docs, architecture docs, or a repo-wide documentation audit. --- ## Workflow Overview ``` 1. ANALYSIS PHASE → analysis.json (structure map) 2. PLANNING PHASE → Audience table + prioritized doc backlog 3. STRUCTURE PHASE → Diátaxis classification + navigation index 4. WRITING PHASE → Per-doc-type required sections 5. COVERAGE PHASE → Edge cases + user journey validation 6. VALIDATION PHASE → DQI score + Known Gaps register ``` --- ## Work Modes | Request shape | Mode | Required output | |---|---|---| | "Write/update a README" for a small project | Lightweight README | README only, plus brief assumptions/gaps if needed | | "Document this repo/codebase" | Full workflow | Audience table, doc backlog, Diátaxis labels, DQI score, Known Gaps register | | "Create API docs" | Focused reference | API reference plus examples/error table; add audience/backlog only if scope expands | | "Audit existing docs" | Validation mode | DQI score, drift findings, prioritized fixes, Known Gaps register | When in lightweight mode, do not force the full six-phase process. Still