/doc-suite-generator
#reference#pipeline#documentation#worksona
David Olsson/doc-suite-generator
Orchestrates comprehensive project documentation from a codebase scan. Produces 13 reports per project. Portfolio-level synthesis for multi-project runs.
Trigger: "document this project", "generate docs", "build project documentation", "analyze my portfolio", "run the full report suite"
Output: docs/01-project-documentation/ ยท Portfolio: portfolio-docs/
Reports: 13 (00โ12) per project + 7 synthesis ยท Sub-skills: 10
Reports (per project)
| # | File | Skill | What it covers |
|---|---|---|---|
| 00 | 00-readme.md | readme-standardizer | Standardized README with badges, getting-started, light spec |
| 01 | 01-executive-summary.md | orchestrator | Documentation index, project summary |
| 02 | 02-project-overview.md | project-scanner | What it is, tech stack, architecture |
| 03 | 03-technical-specification.md | technical-specification | APIs, data models, deployment, security architecture |
| 04 | 04-business-benefits.md | business-benefit-analysis | Value props, ROI, target users, use cases |
| 05 | 05-innovation-themes.md | innovation-themes | What's technically novel |
| 06 | 06-features-capabilities.md | orchestrator | Detailed feature inventory |
| 07 | 07-extensibility.md | extensibility-analysis | Plugin points, growth surfaces |
| 08 | 08-work-zones.md | work-zone-mapper | Thematic development areas |
| 09 | 09-portfolio-position.md | orchestrator | Position in broader portfolio |
| 10 | 10-technical-readiness.md | technical-readiness | Production maturity scorecard |
| 11 | 11-worksona-themes.md | worksona-themes | Leadership runbook alignment |
| 12 | 12-worksona-first-principles.md | worksona-first-principles | 16 structural constraints |
Portfolio Synthesis (multi-project)
| File | What it covers |
|---|---|
00-portfolio-overview.md | All projects summarized, aggregate scorecard |
01-synthesis-ai-innovation.md | AI/ML patterns across portfolio |
02-synthesis-technology.md | Shared tech patterns, convergence/divergence |
03-synthesis-ux.md | UX consistency, onboarding, philosophy |
04-synthesis-worksona-runbook.md | Leadership runbook adherence |
05-synthesis-worksona-fp.md | Structural principle adherence |
06-synthesis-cross-cutting.md | Interconnections, narrative, strategic recommendations |
Usage Modes
| Mode | What happens |
|---|---|
| Single project | Phases 1โ4: scan โ README โ 12 reports โ enrichment pass |
| Batch (portfolio) | Single project ร N, then Phase 5: portfolio synthesis |
| Incremental update | Re-scan, diff against existing docs, regenerate changed sections |
| README-only | Scan + README standardization, skip docs/ |
Workflow
project-scannerinventories the codebasereadme-standardizercreates/updates root README- Ten specialist skills produce reports 02โ12 sequentially
- README enrichment pass with findings from reports
- Executive summary (report 01) ties everything together
- (Portfolio mode) Cross-project synthesis from all individual reports
Integration
- Foundation for everything. Most other pipelines check for existing doc-suite output before running.
- Feeds into: /moat-audit, /landing-page, /ux-audit
- Pairs with: /code-audit for code health + documentation completeness
Use Cases
Share