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-writing.md
View on GitHub# Requirements: Writing Effective Requirements
---
TOKEN_BUDGET: 250
TIER: 3
LOAD_TRIGGER: On-demand when writing requirements (SRS or PRD)
DEPENDENCIES: 02-requirements-srs-vs-prd.md
---
## 2.2 Writing Effective Requirements
### Atomic Requirements
**Characteristics:**
- Each requirement has a unique ID (FR-001, NFR-001)
- One requirement per statement (no "and" clauses)
- Testable and verifiable
- Implementation-neutral (what, not how)
**Example:**
❌ Bad: "The system should be fast and easy to use"
✅ Good: "FR-042: The search API shall return results in under 500ms for 95% of queries"
### User Story Format
```
As a [user type],
I want to [goal],
so that [benefit].
```
**Example:**
```
As a project manager,
I want to assign tasks to team members,
so that work is distributed and tracked.
```
### Acceptance Criteria (Given-When-Then)
```
Given a user is logged in,
When they click "Create Task",
Then a new task form should appear with fields: title, description, due date.
```
### Requirements Quality Checklist
- [ ] **Unique ID**: FR-XXX-001 or NFR-XXX-001 format
- [ ] **Testable**: Can be verified through testing
- [ ] **Atomic**: One requirement, no "and" clauses
- [ ] **Clear**: No ambiguous terms like "fast", "easy", "scalable"
- [ ] **Necessary**: Directly supports a business goal
- [ ] **Traceable**: Linked to source need and test case
---
**End of Writing Effective Requirements 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 |