SpillwaveSolutions/document-specialist-skill / skills/documentation-specialist
documentation-specialist
VerifiedThis 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".
references/templates/markdown/architecture.md
View on GitHub# Architecture document
**System:** `[System name]`
**Version:** `[0.1.0]`
**Status:** `[Proposed | Accepted]`
**Audience:** `[Engineers joining the system]`
**Voice:** `[STE100 | google-docs-style]`
Short C4-first document. Use this when the user wants context, containers, and a key sequence without the full arc42 SDD. For regulated reviews, write `DESIGN_DOC.md` instead.
---
## Purpose
`[Two or three sentences. What the system does. Who uses it.]`
---
## System context
**In scope:** `[list]`
**Out of scope:** `[list]`
```mermaid
flowchart TB
actor([Primary actor])
sys[System name]
ext[External system]
actor --> sys
sys --> ext
```
---
## Containers
| Container | Tech | Role |
|-----------|------|------|
| `[name]` | `[stack]` | `[role]` |
```mermaid
flowchart LR
ui[UI] --> api[API]
api --> db[(Store)]
```
---
## Components
```mermaid
flowchart TB
subgraph api [API]
a[Module A]
b[Module B]
end
a --> b
```
---
## Key sequence
Five participants or fewer.
```mermaid
sequenceDiagram
participant U as User
participant A as API
participant D as Store
U->>A: Request
A->>D: Query
D-->>A: Row
A-->>U: Response
```
---
## Deployment
```mermaid
flowchart LR
lb[Load balancer] --> svc[Service]
svc --> db[(Database)]
```
---
## UI wireframes
One Salt diagram per screen. Do not sketch UI in Mermaid.
```puml
@startuml
salt
{
{+
[Screen title]
{ Field | "value" }
{ [ Cancel ] | [ Save ] }
}
}
@enduml
```
## Decisions to read next
- ADR-001: `[title]`
When a change crosses two containers, update this file in the same PR as the code.
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| 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: 472k | Updated | Claude CodeCodex | Verified | Install |
| 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: 472k | Updated | Claude CodeCodex | Verified | Install |
| rea-tool-designmorluto/reaAudit, investigate, design, or change REA investigation tools, CLI/MCP contracts, provider capabilities, and Evidence semantics. | Stars: 472k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-auditDietrichGebert/ponytailQuality audit of the whole repo: bugs, security, real load, missing tests, speed, and what to delete. Most important first. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |