Systematize Knowledge — JTBD Canvas
Systematize Codebase Knowledge into Structured Documentation
Section titled “Systematize Codebase Knowledge into Structured Documentation”Quick Reference
- Job Performer: AI Agent Alex
- Job Type: Core
- Frequency: On-demand (per project)
- Complexity: Complex
Canvas
Section titled “Canvas”Job Statement
Section titled “Job Statement”When a development team has an undocumented or poorly documented codebase, I want to analyze the code and generate comprehensive documentation automatically, so that the team has a complete, searchable knowledge base without manual writing effort.
Situation and Trigger
Section titled “Situation and Trigger”The team realizes documentation is missing or outdated. A new hire joins and cannot find answers. A senior engineer leaves and takes institutional knowledge with them.
Trigger event: User runs
dockit-master.shor invokes the/DocKit Mastercommand in their AI IDE (scripts/dockit-master.sh:1)
Current Alternatives
Section titled “Current Alternatives”| Alternative | Pros | Cons |
|---|---|---|
| Manual documentation | Full control over content | Time-consuming, always outdated |
| README generators | Quick setup | Shallow — no personas, flows, JTBD |
| Swagger/OpenAPI | Good for API docs | No SOP guides, no architecture docs |
| GitHub Copilot docs | AI-powered | No structured knowledge layer |
Expected Outcome
Section titled “Expected Outcome”- Complete documentation suite: personas, JTBD, flows, architecture, SOP, API
- SEO-optimized pages that rank in search engines
- LLM-readable content for AI research tools like NotebookLM
- Professional Astro Starlight site with search, dark mode, and sidebar navigation
Job Map
Section titled “Job Map”graph TB
MJ["Main: Systematize\ncodebase knowledge"]
SJ1["Analyze codebase"]
SJ2["Generate knowledge layer"]
SJ3["Generate documentation"]
SJ4["Export and deploy"]
MJ --> SJ1
MJ --> SJ2
MJ --> SJ3
MJ --> SJ4
SJ1 --> MJ1["Scan directory structure"]
SJ1 --> MJ2["Detect tech stack"]
SJ2 --> MJ3["Build personas from roles"]
SJ2 --> MJ4["Extract JTBD from features"]
SJ3 --> MJ5["Generate architecture docs"]
SJ3 --> MJ6["Generate SOP guides"]
Job map summary: The main job decomposes into four small jobs — analyze, build knowledge, generate docs, and export. Each small job contains specific micro-jobs that map to individual skill files.
Job Steps
Section titled “Job Steps”| Step | Small Job | Micro-jobs | Source |
|---|---|---|---|
| 1 | Analyze codebase | Scan dirs, detect stack, map routes, extract schema | skills/analyze-codebase.md:7-56 |
| 2 | Generate knowledge | Build personas, extract JTBD, map flows | skills/persona-builder.md, skills/jtbd-analyzer.md, skills/flow-mapper.md |
| 3 | Generate documentation | Architecture, database, deployment, SOP, API | skills/tech-docs.md, skills/sop-guide.md, skills/api-reference.md |
| 4 | Export and deploy | Build Astro site, generate sitemap, run SEO audit | workflows/setup-astro.md, workflows/generate-sitemap.md |
Related
Section titled “Related”- Persona: AI Agent Alex
- Flow: Skill pipeline workflow
- SOP: Generating tech docs