| name | documentation-specialist |
| description | This skill should be used when creating professional software documentation (SRS, PRD, OpenAPI,
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 for wireframes and leftover UML). Use when asked to "create documentation",
"document my code", "write SRS", "generate PRD", "wireframe", or "documentation specialist".
|
| version | 3.2.2-PDA |
| allowed-tools | ["Read","Write","Edit","Glob","Grep","Bash","Skill"] |
Documentation Specialist Skill
Quick Start
Software documentation creation, extraction, conversion, and diagramming capabilities.
Capabilities:
- Greenfield - Create documentation from templates (SRS, PRD, OpenAPI, User Manuals, Tutorials, Runbooks)
- Brownfield - Reverse-engineer documentation from code (Spring Boot, FastAPI)
- Audit - Review and improve existing documentation
- Convert - Transform formats (MD to DOCX to PDF)
- Diagram - Mermaid first (C4, sequence, class, ER, state, flowchart). PlantUML for wireframes and types Mermaid cannot do easily.
Example Requests:
Create an SRS for a billing system with PCI-DSS compliance
Document my Spring Boot application at ~/projects/customer-api
Create a user manual for my SaaS product
Write a database failover runbook
Audit my API documentation at docs/api/openapi.yaml
Convert docs/srs.md to Word format
Create a C4 container diagram for my microservices
Draw a login wireframe
Execution Flow:
- Classify intent to 2. Choose one voice pack to 3. Load workflow to 4. Execute steps to 5. Generate documentation to 6. Present post-processing options
Voice pack (required, pick one)
Every document this skill writes uses exactly one voice pack. Do not mix them.
| Pack | When | Source |
|---|
| STE100 (default) | Procedures, runbooks, manuals, architecture docs, code walkthroughs, requirements, and any request that does not name Google style | ste100 skill (SpillwaveSolutions/ste100-agent-plugins) |
| google-docs-style | User says "Google style", "Google docs style", or "developer style guide" | google-docs-style skill (SpillwaveSolutions/google-docs-style) |
Default is STE100. Switch only when the user names Google style. If both are named, ask which pack to use. Do not apply both.
Hard bans (both packs)
These apply even if a template or prior draft used them:
- Do not use an em dash (
—) or a double hyphen standing in for one (-- as punctuation). Use a period or a comma.
- Do not start a sentence with So, That, Thus, or Hence.
- Do not start a sentence with a dangling demonstrative ("That is why..." as a lead).
STE100 also requires: short sentences, one instruction per step, active voice, no contractions, no e.g. / i.e. / etc., no weak modals in steps. Load 11-voice-and-style.md.
After the draft exists, run the chosen pack:
- STE100: follow the local orchestrator / editor / adversary loop in the
ste100 skill. No network.
- Google style: run
python3 scripts/google_docs_style.py --lint --check when that skill is installed.
Intent Classification
| Intent | Keywords | Workflow |
|---|
| CREATE_NEW | "create", "generate", "write" + doc type | greenfield-workflow.md |
| CODE_TO_DOCS | "document", "extract", path reference | brownfield-workflow.md |
| AUDIT | "audit", "review", "check", "improve" | audit-workflow.md |
| CONVERT | "convert", "to Word", "to PDF" | convert-workflow.md |
| DIAGRAM | "diagram", "C4", "sequence", "ER", "class", "state", "wireframe", "mock" | diagram-workflow.md |
| USER_DOCS | "user manual", "how-to", "getting started" | user-docs-workflow.md |
| TUTORIAL | "tutorial", "API guide", "CLI docs" | tutorial-workflow.md |
| RUNBOOK | "runbook", "procedure", "incident" | runbook-workflow.md |
CRITICAL: Load only the workflow needed for the current intent. Avoid loading multiple workflows.
Document Type to Template
Requirements and Design:
User Documentation:
Developer and Operations:
Framework Detection (Brownfield)
Process: Glob for detection files to Grep for patterns to Load mapping to Follow brownfield workflow
On-Demand Resources
Load only what is needed for the current task.
Workflows
Reference Guides
Examples
Skill Integration
| Skill | Invocation Trigger |
|---|
| ste100 | Default voice pack. Procedures, runbooks, architecture docs, walkthroughs, requirements |
| google-docs-style | User names Google style. Mutually exclusive with ste100 |
| design-doc-mermaid | Default diagrams: C4, flowchart, sequence, class, ER, state, component views. GitHub wiki renders the fence. |
| plantuml | Wireframes (Salt), use case, timing, ArchiMate, nwdiag, WBS. Always PNG or SVG. |
| docx | Request includes Word format |
| pdf | Request includes PDF format |
When WikiTicket SDD asks for an architecture doc, a code walkthrough, or a
requirements doc, use this skill for prose and wireframes, design-doc-mermaid
for every GitHub-safe diagram, and plantuml only for leftover types.
GitHub wiki: embed Mermaid. Upload PlantUML images with the page.
Confluence: render Mermaid and PlantUML to PNG or SVG and upload both.
Error Handling
| Error | Response |
|---|
| Cannot detect framework | Ask: "Is this Spring Boot, FastAPI, or another framework?" |
| Missing template | Use closest match, inform user |
| Skill not available | Offer markdown-only alternative |
| Ambiguous request | Ask: "Would you prefer SRS (formal) or PRD (agile)?" |
| Both voice packs named | Ask which pack to use. Do not mix |
End of SKILL.md (v3.2.2-PDA)
