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/02-requirements-traceability.md
View on GitHub# Requirements: Traceability and Context
---
TOKEN_BUDGET: 200
TIER: 3
LOAD_TRIGGER: On-demand when creating traceability matrices or system context diagrams
DEPENDENCIES: 02-requirements-writing.md
---
## 2.3 Requirements Traceability
Every requirement should link to:
- **Source**: User need or business goal
- **Design**: Component that implements it
- **Test**: Test case that verifies it
### Requirements Traceability Matrix
| Req ID | Description | Design Component | Test Case | Priority | Status |
|--------|-------------|------------------|-----------|----------|--------|
| FR-001 | User login | AuthController | TC-001 | Must | ✅ Done |
| FR-002 | Create task | TaskService | TC-005 | Must | ⏳ In Progress |
| NFR-001 | Response < 500ms | Redis cache | TC-050 | Should | 📋 Planned |
## 2.4 System Context Diagrams
A **System Context Diagram** (C4 Level 1 or DFD Level 0) defines the system boundary:
```mermaid
C4Context
title System Context: Task Management Platform
Person(user, "Team Member", "Uses the platform to manage tasks")
Person(admin, "Admin", "Configures the system")
System(taskSystem, "Task Management System", "Organizes tasks, assignments, and deadlines")
System_Ext(googleAuth, "Google OAuth", "Authenticates users")
System_Ext(email, "Email Service", "Sends notifications")
System_Ext(analytics, "Analytics Platform", "Tracks usage metrics")
Rel(user, taskSystem, "Uses")
Rel(admin, taskSystem, "Configures")
Rel(taskSystem, googleAuth, "Authenticates with")
Rel(taskSystem, email, "Sends emails via")
Rel(taskSystem, analytics, "Sends events to")
```
**Purpose**: Shows what's inside vs. outside the system, clarifying scope and dependencies.
---
**End of Requirements Traceability 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: 471k | 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: 471k | 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: 471k | 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 |