documentation-specialist
This skill should be used when creating professional software documentation (SRS, PRD, OpenAPI, SDD, architecture docs, user manuals, tutorials, runbooks) from templates (greenfield) or reverse-engineering documentation from existing code like Spring Boot or FastAPI (brownfield). Also handles documentation audits/reviews, format conversion (Markdown, DOCX, PDF), and diagram generation (Mermaid first: C4, sequence, class, ER, state, flowchart; PlantUML Salt for UI wireframes and leftover UML). Use when asked to "create documentation", "document my code", "write SRS", "generate PRD", "write DESIGN_DOC.md", "architecture document", "wireframe", or "documentation specialist".
Pinned to revision 29e75b839b19, so it is the text this page describes rather than whatever the author pushed since.
Pre-approved tools experimental
Experimental field. Support varies between clients, so this list is what the author declared, not what your client will enforce.
- Read
- Write
- Edit
- Glob
- Grep
- Bash
- Skill
Files
- skills/documentation-specialist/SKILL.md
- skills/documentation-specialist/references/examples/TOC.md
- skills/documentation-specialist/references/examples/brownfield/database-failover-runbook.md
- skills/documentation-specialist/references/examples/brownfield/spring-boot-sdd.md
- skills/documentation-specialist/references/examples/greenfield/adr-microservices.md
- skills/documentation-specialist/references/examples/greenfield/architecture-doc.md
- skills/documentation-specialist/references/examples/greenfield/billing-srs.md
- skills/documentation-specialist/references/examples/greenfield/cli-getting-started.md
- skills/documentation-specialist/references/examples/greenfield/collaboration-prd.md
- skills/documentation-specialist/references/examples/greenfield/document-specialist-sdd.md
- skills/documentation-specialist/references/examples/greenfield/ecommerce-sdd.md
- skills/documentation-specialist/references/examples/greenfield/rest-api-tutorial.md
- skills/documentation-specialist/references/examples/greenfield/task-api-openapi.yaml
- skills/documentation-specialist/references/examples/greenfield/taskmanager-user-manual.md
- skills/documentation-specialist/references/examples/greenfield/ui-wireframes.md
- skills/documentation-specialist/references/guides/requirements/README.md
- skills/documentation-specialist/references/mappings/backend/fastapi-mapping.yaml
- skills/documentation-specialist/references/mappings/backend/spring-boot-mapping.yaml
- skills/documentation-specialist/references/reference/01-philosophy.md
- skills/documentation-specialist/references/reference/02-requirements-srs-vs-prd.md
- skills/documentation-specialist/references/reference/02-requirements-traceability.md
- skills/documentation-specialist/references/reference/02-requirements-writing.md
- skills/documentation-specialist/references/reference/03-design-adrs.md
- skills/documentation-specialist/references/reference/03-design-arc42.md
- skills/documentation-specialist/references/reference/03-design-requirements-matrix.md
- skills/documentation-specialist/references/reference/04-diagrams-c4-hierarchy.md
- skills/documentation-specialist/references/reference/04-diagrams-selection.md
- skills/documentation-specialist/references/reference/04-diagrams-state-vs-activity.md
- skills/documentation-specialist/references/reference/05-api-checklist.md
- skills/documentation-specialist/references/reference/05-api-openapi.md
- skills/documentation-specialist/references/reference/05-api-stripe-gold-standard.md
- skills/documentation-specialist/references/reference/06-deployment-diagrams.md
- skills/documentation-specialist/references/reference/06-deployment-documentation.md
- skills/documentation-specialist/references/reference/06-deployment-runbooks.md
- skills/documentation-specialist/references/reference/06-operational-docs.md
- skills/documentation-specialist/references/reference/07-user-kb-approach.md
- skills/documentation-specialist/references/reference/07-user-kb-template.md
- skills/documentation-specialist/references/reference/07-user-writing-style.md
- skills/documentation-specialist/references/reference/08-agile-process.md
- skills/documentation-specialist/references/reference/08-tutorial-writing.md
- skills/documentation-specialist/references/reference/09-code-to-docs-detection.md
- skills/documentation-specialist/references/reference/09-code-to-docs-example.md
- skills/documentation-specialist/references/reference/09-code-to-docs-when.md
- skills/documentation-specialist/references/reference/09-code-to-docs-workflow.md
- skills/documentation-specialist/references/reference/10-quality-bonsai-pruning.md
- skills/documentation-specialist/references/reference/10-quality-checklist.md
- skills/documentation-specialist/references/reference/10-quality-metrics.md
- skills/documentation-specialist/references/reference/11-voice-and-style.md
- skills/documentation-specialist/references/reference/comprehensive-guide.md
- skills/documentation-specialist/references/templates/markdown/DESIGN_DOC.md
- skills/documentation-specialist/references/templates/markdown/api-openapi.yaml
- skills/documentation-specialist/references/templates/markdown/architecture.md
- skills/documentation-specialist/references/templates/markdown/design-sdd.md
- skills/documentation-specialist/references/templates/markdown/developer-tutorial.md
- skills/documentation-specialist/references/templates/markdown/getting-started.md
- skills/documentation-specialist/references/templates/markdown/howto-guide.md
- skills/documentation-specialist/references/templates/markdown/requirements-prd.md
- skills/documentation-specialist/references/templates/markdown/requirements-srs.md
- skills/documentation-specialist/references/templates/markdown/runbook.md
- skills/documentation-specialist/references/templates/markdown/user-manual.md
- skills/documentation-specialist/references/workflows/TOC.md
- skills/documentation-specialist/references/workflows/audit-workflow.md
- skills/documentation-specialist/references/workflows/brownfield-workflow.md
- skills/documentation-specialist/references/workflows/brownfield/fastapi-guide.md
- skills/documentation-specialist/references/workflows/brownfield/pulumi-guide.md
- skills/documentation-specialist/references/workflows/brownfield/springboot-guide.md
- skills/documentation-specialist/references/workflows/convert-workflow.md
- skills/documentation-specialist/references/workflows/design-workflow.md
- skills/documentation-specialist/references/workflows/diagram-workflow.md
- skills/documentation-specialist/references/workflows/greenfield-workflow.md
- skills/documentation-specialist/references/workflows/greenfield/advanced.md
- skills/documentation-specialist/references/workflows/greenfield/openapi-guide.md
- skills/documentation-specialist/references/workflows/greenfield/prd-guide.md
- skills/documentation-specialist/references/workflows/greenfield/srs-guide.md
- skills/documentation-specialist/references/workflows/runbook-workflow.md
- skills/documentation-specialist/references/workflows/tutorial-workflow.md
- skills/documentation-specialist/references/workflows/user-docs-workflow.md
Every link opens the file at its source, pinned to the revision this page describes.