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/reference/06-deployment-diagrams.md
View on GitHub# Deployment: Diagrams
---
TOKEN_BUDGET: 250
TIER: 3
LOAD_TRIGGER: On-demand when creating deployment diagrams
DEPENDENCIES: 04-diagrams-selection.md, 06-deployment-documentation.md
---
## 6.2 Deployment Diagrams
**UML Deployment Diagram:**
- Shows physical infrastructure
- Maps software to hardware
- Displays network topology
### Example (PlantUML)
```plantuml
@startuml
node "Load Balancer" as lb {
artifact "Nginx"
}
node "Application Server 1" as app1 {
artifact "API Service" as api1
}
node "Application Server 2" as app2 {
artifact "API Service" as api2
}
database "PostgreSQL" as db {
artifact "Primary DB"
}
database "Redis" as cache {
artifact "Cache"
}
cloud "AWS S3" as s3 {
artifact "File Storage"
}
lb --> app1 : HTTP/HTTPS
lb --> app2 : HTTP/HTTPS
app1 --> db : PostgreSQL Protocol
app2 --> db : PostgreSQL Protocol
app1 --> cache : Redis Protocol
app2 --> cache : Redis Protocol
app1 --> s3 : S3 API
app2 --> s3 : S3 API
@enduml
```
### What to Show
**Infrastructure Nodes:**
- Servers (physical or virtual)
- Containers (Docker, Kubernetes pods)
- Databases
- Caches
- Message queues
- Load balancers
- CDNs
- Cloud services (S3, SQS, etc.)
**Connections:**
- Protocols (HTTP, PostgreSQL, Redis)
- Ports (8080, 5432, 6379)
- Security (TLS/SSL)
**Deployment Units:**
- Artifacts (JARs, Docker images)
- Configuration files
- Static assets
### Use Cases
**Use deployment diagrams for:**
1. **Onboarding**: Help new engineers understand infrastructure
2. **Incident Response**: Visualize dependencies during outages
3. **Capacity Planning**: Identify bottlenecks and scaling opportunities
4. **Security Reviews**: Show attack surface and trust boundaries
5. **Compliance**: Document data flows for audits
---
**End of Deployment Diagrams Guide**
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 |