Skip to content

SpillwaveSolutions/document-specialist-skill / skills/documentation-specialist

documentation-specialist

Verified

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".

FileKindSize
SKILL.mdskill md10.0 KB
references/examples/TOC.mdmarkdown6.5 KB
references/examples/brownfield/database-failover-runbook.mdmarkdown8.1 KB
references/examples/brownfield/spring-boot-sdd.mdmarkdown5.6 KB
references/examples/greenfield/adr-microservices.mdmarkdown6.3 KB
references/examples/greenfield/architecture-doc.mdmarkdown3.7 KB
references/examples/greenfield/billing-srs.mdmarkdown12.4 KB
references/examples/greenfield/cli-getting-started.mdmarkdown9.3 KB
references/examples/greenfield/collaboration-prd.mdmarkdown13.8 KB
references/examples/greenfield/document-specialist-sdd.mdmarkdown15.4 KB
references/examples/greenfield/ecommerce-sdd.mdmarkdown7.8 KB
references/examples/greenfield/rest-api-tutorial.mdmarkdown13.8 KB
references/examples/greenfield/task-api-openapi.yamlconfig19.0 KB
references/examples/greenfield/taskmanager-user-manual.mdmarkdown8.7 KB
references/examples/greenfield/ui-wireframes.mdmarkdown5.8 KB
references/guides/requirements/README.mdmarkdown3.7 KB
references/mappings/backend/fastapi-mapping.yamlconfig9.7 KB
references/mappings/backend/spring-boot-mapping.yamlconfig24.1 KB
references/reference/01-philosophy.mdmarkdown2.0 KB
references/reference/02-requirements-srs-vs-prd.mdmarkdown1.2 KB
references/reference/02-requirements-traceability.mdmarkdown1.7 KB
references/reference/02-requirements-writing.mdmarkdown1.4 KB
references/reference/03-design-adrs.mdmarkdown2.2 KB
references/reference/03-design-arc42.mdmarkdown2.6 KB
references/reference/03-design-requirements-matrix.mdmarkdown1.3 KB
references/reference/04-diagrams-c4-hierarchy.mdmarkdown2.0 KB
references/reference/04-diagrams-selection.mdmarkdown5.1 KB
references/reference/04-diagrams-state-vs-activity.mdmarkdown2.3 KB
references/reference/05-api-checklist.mdmarkdown2.0 KB
references/reference/05-api-openapi.mdmarkdown3.4 KB
references/reference/05-api-stripe-gold-standard.mdmarkdown1.8 KB
references/reference/06-deployment-diagrams.mdmarkdown1.8 KB
references/reference/06-deployment-documentation.mdmarkdown2.9 KB
references/reference/06-deployment-runbooks.mdmarkdown2.5 KB
references/reference/06-operational-docs.mdmarkdown2.7 KB
references/reference/07-user-kb-approach.mdmarkdown1.8 KB
references/reference/07-user-kb-template.mdmarkdown3.1 KB
references/reference/07-user-writing-style.mdmarkdown2.0 KB
references/reference/08-agile-process.mdmarkdown3.2 KB
references/reference/08-tutorial-writing.mdmarkdown7.4 KB
references/reference/09-code-to-docs-detection.mdmarkdown2.5 KB
references/reference/09-code-to-docs-example.mdmarkdown3.2 KB
references/reference/09-code-to-docs-when.mdmarkdown1.7 KB
references/reference/09-code-to-docs-workflow.mdmarkdown2.0 KB
references/reference/10-quality-bonsai-pruning.mdmarkdown2.4 KB
references/reference/10-quality-checklist.mdmarkdown2.6 KB
references/reference/10-quality-metrics.mdmarkdown3.1 KB
references/reference/11-voice-and-style.mdmarkdown1.5 KB
references/reference/comprehensive-guide.mdmarkdown7.3 KB
references/templates/markdown/DESIGN_DOC.mdmarkdown4.5 KB
references/templates/markdown/api-openapi.yamlconfig17.7 KB
references/templates/markdown/architecture.mdmarkdown1.6 KB
references/templates/markdown/design-sdd.mdmarkdown143 B
references/templates/markdown/developer-tutorial.mdmarkdown7.1 KB
references/templates/markdown/getting-started.mdmarkdown6.5 KB
references/templates/markdown/howto-guide.mdmarkdown4.1 KB
references/templates/markdown/requirements-prd.mdmarkdown10.2 KB
references/templates/markdown/requirements-srs.mdmarkdown17.0 KB
references/templates/markdown/runbook.mdmarkdown8.8 KB
references/templates/markdown/user-manual.mdmarkdown4.8 KB
references/workflows/TOC.mdmarkdown1.9 KB
references/workflows/audit-workflow.mdmarkdown2.5 KB
references/workflows/brownfield-workflow.mdmarkdown3.6 KB
references/workflows/brownfield/fastapi-guide.mdmarkdown1.8 KB
references/workflows/brownfield/pulumi-guide.mdmarkdown1.9 KB
references/workflows/brownfield/springboot-guide.mdmarkdown2.2 KB
references/workflows/convert-workflow.mdmarkdown1.4 KB
references/workflows/design-workflow.mdmarkdown3.0 KB
references/workflows/diagram-workflow.mdmarkdown3.7 KB
references/workflows/greenfield-workflow.mdmarkdown3.4 KB
references/workflows/greenfield/advanced.mdmarkdown1.9 KB
references/workflows/greenfield/openapi-guide.mdmarkdown2.5 KB
references/workflows/greenfield/prd-guide.mdmarkdown2.0 KB
references/workflows/greenfield/srs-guide.mdmarkdown2.0 KB
references/workflows/runbook-workflow.mdmarkdown2.4 KB
references/workflows/tutorial-workflow.mdmarkdown2.3 KB
references/workflows/user-docs-workflow.mdmarkdown2.3 KB

references/workflows/diagram-workflow.md

View on GitHub
# Diagram Generation Workflow

---
TOKEN_BUDGET: 520
TIER: 2
LOAD_TRIGGER: Intent = DIAGRAM
DEPENDENCIES: SKILL.md
---

## Overview

Default tool is `design-doc-mermaid`. GitHub Flavored Markdown and GitHub
wiki render fenced `mermaid` blocks. They do not render PlantUML source.

Use `plantuml` only when Mermaid cannot do the job easily, or when the
publish target needs a raster image that PlantUML already owns.

## Publish targets

| Target | Mermaid | PlantUML |
|--------|---------|----------|
| GitHub wiki / GFM | Keep the fenced `mermaid` block. It renders. | Never leave a raw `puml` fence as the only view. Render PNG or SVG, commit it under `docs/diagrams/`, link the image, and upload the image with the wiki page. |
| Confluence / Notion / Word / PDF | Render PNG or SVG with `mmdc` or `scripts/resilient_diagram.py`. Upload the image. Do not rely on Confluence to render Mermaid. | Render PNG or SVG. Upload the image. |

## Step 1: Identify diagram type

| Keywords | Diagram | Tool |
|----------|---------|------|
| C4 context, system overview | C4 Context | design-doc-mermaid |
| C4 container, services | C4 Container | design-doc-mermaid |
| C4 component, modules | C4 Component or flowchart | design-doc-mermaid |
| flowchart, process | Flowchart | design-doc-mermaid |
| sequence, call flow | Sequence | design-doc-mermaid |
| class, inheritance | Class (`classDiagram`) | design-doc-mermaid |
| ER, database, entities | ER (`erDiagram`) | design-doc-mermaid |
| state, lifecycle | State (`stateDiagram-v2`) | design-doc-mermaid |
| activity, workflow | Flowchart | design-doc-mermaid |
| component boxes, module graph | Flowchart | design-doc-mermaid |
| deployment, topology (boxes and arrows) | Flowchart | design-doc-mermaid |
| wireframe, mock, UI sketch | Salt wireframe | plantuml |
| use case, actors and goals | Use case | plantuml |
| timing, clock, waveform | Timing | plantuml |
| ArchiMate, enterprise layer | ArchiMate | plantuml |
| network rack, nwdiag | Network | plantuml |
| WBS | WBS | plantuml |
| JSON or YAML tree | JSON/YAML viz | plantuml |

If GitHub fails to render an experimental Mermaid type (C4, `architecture-beta`,
`block-beta`), fall back to `flowchart TD`. Do not switch to PlantUML for that
reason on wiki.

## Step 2: Gather content

Derive nodes from code and config. Cap node count at about 16. Write "+N more"
instead of silent truncation.

**Wireframes**: real screens, labels, and controls. Use PlantUML Salt. Render
an image. Link it. Keep the `.puml` source.

## Step 3: Invoke skill

**Mermaid (`design-doc-mermaid`)**

```
Task: Generate [type] diagram
System: [name]
Elements: [list from repo]
Output: fenced mermaid block in the host Markdown
Also save: docs/diagrams/[filename].mmd
Validate: scripts/resilient_diagram.py or mmdc
Confluence: also render PNG/SVG and upload
```

**PlantUML (`plantuml`) — leftover types and images only**

```
Task: Generate [wireframe | use case | timing | ArchiMate | network | WBS]
Output: docs/diagrams/[filename].puml
Always render: PNG or SVG
Always link the image from the Markdown
Wiki: upload the image with the page
Confluence: upload the image
```

## Step 4: Present options

```
Generated [diagram type]: [path]

Wiki: Mermaid stays inline. PlantUML is an image link plus uploaded file.
Confluence: both are images.
```

## Quick reference

| Show | Tool | Wiki | Confluence |
|------|------|------|------------|
| Context, containers, sequence, class, ER, state, activity | design-doc-mermaid | fenced mermaid | PNG/SVG upload |
| Wireframe, use case, timing, ArchiMate, nwdiag, WBS | plantuml | PNG/SVG upload | PNG/SVG upload |

For detailed guidance: [04-diagrams-selection.md](../reference/04-diagrams-selection.md)
rea-analysis-optimizationmorluto/reaOptimize REA providers and shared analysis workflows for agent context, latency, CPU, and memory while preserving correctness and Evidence. Use for analysis bottlenecks and cache or query design; CI/test-suite optimization belongs to rea-ci-tests-audit.Stars: 471kUpdated Claude CodeCodexVerifiedInstall
rea-ci-tests-auditmorluto/reaAudit REA CI and test suites for correctness, fixture drift, false passes, and measured performance; use for suite or workflow investigations and efficiency changes, rather than ordinary feature testing or a single test failure.Stars: 471kUpdated Claude CodeCodexVerifiedInstall
rea-tool-designmorluto/reaAudit, investigate, design, or change REA investigation tools, CLI/MCP contracts, provider capabilities, and Evidence semantics.Stars: 471kUpdated Claude CodeCodexVerifiedInstall
ponytail-auditDietrichGebert/ponytailQuality audit of the whole repo: bugs, security, real load, missing tests, speed, and what to delete. Most important first.Stars: 194kUpdated Claude CodeCodexVerifiedInstall