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/04-diagrams-c4-hierarchy.md
View on GitHub# Diagrams: C4 Model Hierarchy
---
TOKEN_BUDGET: 200
TIER: 3
LOAD_TRIGGER: On-demand when creating C4 diagrams
DEPENDENCIES: 04-diagrams-selection.md
---
## 4.3 C4 Model Hierarchy
The C4 model provides a hierarchical way to document software architecture by "zooming in" through four levels.
### Level 1: System Context
**Shows**: The system as a single box
**Includes**: External users and systems
**Purpose**: High-level interactions and system boundary
**Audience**: Non-technical stakeholders, executives
**Example**: Task Management System with external OAuth, Email, Analytics
---
### Level 2: Container
**Shows**: "Zooms in" to show deployable units
**Includes**: Web apps, APIs, databases, message queues
**Purpose**: Show the major technology choices and how they communicate
**Audience**: Technical leads, architects
**Example**: Web App (React) → API (Spring Boot) → Database (PostgreSQL)
---
### Level 3: Component
**Shows**: "Zooms in" on a single container
**Includes**: Internal components (controllers, services, repositories)
**Purpose**: Show the internal structure and responsibilities
**Audience**: Developers working on that container
**Example**: Inside API container: TaskController, TaskService, TaskRepository
---
### Level 4: Code (Optional)
**Shows**: "Zooms in" on a component
**Includes**: Class diagrams or UML
**Purpose**: Detailed implementation structure
**Audience**: Developers implementing that component
**Note**: Often auto-generated from code, not manually maintained
---
### When to Create Each Level
| Level | When to Create |
|-------|----------------|
| Level 1: Context | Always (defines system boundary) |
| Level 2: Container | For all systems (shows architecture) |
| Level 3: Component | For complex containers |
| Level 4: Code | Rarely (auto-generate or skip) |
### Integration with arc42
- C4 Level 1 → arc42 Section 3 (Context and Scope)
- C4 Level 2-3 → arc42 Section 5 (Building Block View)
---
**End of C4 Model Hierarchy 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 |