docgen
Docgen
Systematic documentation generation with progress tracking and completeness guarantees. Analyzes code file-by-file, ensures nothing is skipped, and produces structured output per component.
Docgen complements flow-docs — it provides the systematic analysis engine for flow-docs' five-phase workflow. It can also be used standalone for ad-hoc documentation tasks when you need structured, complete documentation without a full flow-docs run.
The core guarantee: every file in scope gets documented. Progress is tracked explicitly ([3/12 files documented]) so you always know what's been covered and what remains.
Workflow
1. Scope the Target
Identify what needs documenting: single file, directory, module, or entire package. Be specific — "the auth module" means every file in that directory.
2. Build the File Manifest
Enumerate every file to document with its path. This is the completeness checklist — no file gets dropped silently. Count them: this is your denominator.