Documentation Workflows¶
Workflows for creating, restructuring, remediating, and reviewing documentation. Covers greenfield doc creation through multi-persona quality review.
How to Start¶
The doc workflow router classifies your doc state and recommends the right entry point:
Greenfield (no docs exist) →
docs-create.00_docs_plan_slicing_parallelBrownfield (RST exists, needs restructuring) →
docs-restructure.00_readiness_content_auditMaintained (docs exist, need updating) →
task.docs.docs-update
Or describe your intent directly:
“Create documentation for this project” → docs-create suite
“Restructure the existing docs” → docs-restructure suite
“The docs are stale, audit and fix” → doc-remediation suite
“Review the docs from a user’s perspective” → doc-persona-review suite
Docs Create¶
Build documentation from scratch with structured planning and Sphinx integration.
Step |
Skill |
What it does |
|---|---|---|
0 |
|
Inventory docs and code, classify tiers, slice into plans |
1 |
|
Author one doc plan with tier classification and evidence |
2 |
|
Execute a plan: write content using surface type templates |
3 |
|
Plan Sphinx wiring: toctree, man pages, build config |
4 |
|
Execute the Sphinx plan: conf.py, toctree, build validation |
Docs Restructure¶
Reorganize existing RST documentation into a coherent structure.
Step |
Skill |
What it does |
|---|---|---|
0 |
|
Audit Sphinx infrastructure and content completeness |
1 |
|
Slice restructuring work into disjoint plans |
2 |
|
Execute each restructure plan |
3 |
|
Full rebuild, conformance certification, polish |
Doc Remediation¶
Fix documentation gaps and quality issues with a structured multi-pass approach.
Step |
Skill |
What it does |
|---|---|---|
0 |
|
Establish baseline and gather context |
1 |
|
Create or fix the “Why this project?” page |
2 |
|
Create or fix the architecture overview |
3 |
|
Create or fix workflow narrative pages |
4 |
|
Improve example coverage and diversity |
5 |
|
Fix cross-references, formatting, consistency |
6 |
|
Final validation pass |
Doc Persona Review¶
Multi-persona documentation review for quality assurance.
Step |
Skill |
What it does |
|---|---|---|
0 |
|
Define the persona roster for review |
1 |
|
Run review per persona, triage findings between passes |
2 |
|
Summarize findings and recommend next steps |
See Also¶
Skill Runtime — how skills are compiled and discovered
Glossary — documentation tier definitions