← ClaudeAtlas

full-documentlisted

Full-repo documentation pass — audit what's documented vs what exists, then create and update the repo's docs until it is fully understandable by any future maintainer or LLM. Use for "document the whole repo", "full doc scan", "get this repo documented end to end", or on an unfamiliar/inherited codebase.
danielimad/SKILLS · ★ 0 · Data & Documents · score 54
Install: claude install-skill danielimad/SKILLS
# Full-Document — whole-repo coverage (project-agnostic) Goal: a cold maintainer or LLM can open the docs folder (`.docs/` by default; if the repo's runbook names a different one, the runbook wins) and understand the entire system — what it is, how it works, why it's built this way, and where every mistake-prone edge lives — without reading all the code. This is the repo-wide version of /document. ## Phase 1 — Map before writing 1. Read the repo structure, entry points, package manifests, existing `.docs/` (if any), README, migrations, CI config. Build a mental model of every subsystem. 2. **Gap audit**: list each subsystem/feature and mark documented / partial / undocumented. Present this list first — it's the work plan. Never silently decide scope. 3. Treat `architecture.md` (and any project-designated protected file) as extend-only — never rewritten without an explicit go. ## Phase 2 — The document set every project should have Create/update these under `.docs/` (skip only what genuinely doesn't apply, and say which): - **`architecture.md`** — the live system: layers, data flow, how major components connect, the doc index. The map everything else hangs off. - **`codebase-map.md`** — what every significant file/module does, one line each. The "where is X" lookup. - **`domain-model.md`** — what the business logic MEANS (entities, states, the definition of every money/date/status value). Screens render this; they don't invent it. - **`decisions.md`** — append-only log: ea