superdocs
Superdocs: Deep Codebase Documentation Generator
Generate a docs/ directory of markdown files that give AI agents and human contributors deep context on any codebase.
Scope: Superdocs works on codebases — repositories containing source code with build/test/deploy pipelines. It does not generate documentation for pure-docs projects, wikis, or non-code repositories.
Re-runnable: Safe to run multiple times. First run generates from scratch (migrating existing docs if found). Subsequent runs detect what changed in the codebase since the last docs update and refresh only stale content.
References: See RESEARCH-PROMPTS.md for codebase exploration prompts, DOC-TEMPLATES.md for document templates, EXAMPLE-OUTPUT.md for a sample output walkthrough.
Philosophy
Documentation should answer three questions at every level:
| Question | What It Captures | Example |
|---|---|---|
| WHAT | Facts, structures, components | "This is a REST API built with Express" |
| HOW | Processes, flows, mechanics | "Requests pass through auth middleware, then route handlers" |
| WHY | Rationale, trade-offs, history | "We chose SQLite over Postgres for single-binary deployment" |