What problem does it solve?
Helps teams and AI agents generate comprehensive, resume-capable documentation for existing (brownfield) codebases so that knowledge is captured, reproducible, and actionable for architecture review, feature planning, and onboarding.
Core Features & Use Cases
- Resumable Scans & State Tracking: Initializes and maintains a project-scan-report.json to allow pausing and resuming long analyses across quick, deep, and exhaustive modes.
- Batched File Reading & Deep-Dive Workflows: Supports batched processing of large repositories, exhaustive per-file deep-dive analysis, dependency graphs, and data-flow tracing to produce deep-dive reports and per-part architecture docs.
- Validated Outputs & Templates: Writes and validates markdown artifacts (index.md, architecture.md, api-contracts.md, deep-dive-*.md) using provided templates and checklist-driven validation to ensure generated docs are immediately useful.
- Use Case: Run an exhaustive deep-dive on a monorepo to produce per-part architecture files, API contracts, and a deep-dive analysis of a critical feature folder for planning a brownfield PRD.
Quick Start
Run an exhaustive scan of the repository to generate an AI-friendly documentation index and deep-dive reports.