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/workflows/runbook-workflow.md
View on GitHub# Operational Runbook Workflow
---
TOKEN_BUDGET: 300
TIER: 2
LOAD_TRIGGER: Intent = CREATE_RUNBOOK
DEPENDENCIES: SKILL.md
---
## Overview
Create operational runbooks for DevOps teams.
**Supported**: Incident Response, Deployment Procedures, Maintenance Tasks, On-Call Procedures
## Workflow Steps
### Step 1: Identify Runbook Type
| Keywords | Type | Focus |
|----------|------|-------|
| "incident", "outage" | Incident Response | Triage, recovery |
| "deploy", "release", "rollback" | Deployment | Release procedures |
| "backup", "maintenance" | Maintenance | Scheduled tasks |
| "on-call", "alert" | On-Call | Alert handling |
### Step 2: Load Template
Read: `templates/markdown/runbook.md`
Example: [database-failover-runbook.md](../examples/brownfield/database-failover-runbook.md)
### Step 3: Gather Context
Extract from user request:
1. **Purpose** - Problem this runbook solves
2. **Trigger** - Conditions for using this runbook
3. **Owner** - Team or person responsible
4. **Systems** - Services involved
5. **SLA** - Time targets for resolution
### Step 4: Generate Content
**Runbook Structure**:
```markdown
# [Procedure Name] Runbook
## Overview
- Purpose: [What this runbook accomplishes]
- Owner: [Team/person responsible]
- Last Updated: [Date]
- SLA: [Time target]
## Prerequisites
- [ ] Access to [systems]
- [ ] Credentials for [services]
- [ ] Tools: [required tools]
## Procedure
### Step 1: [Action]
```bash
# Command to execute
command --flag value
```
**Expected result**: [What should happen]
**If this fails**: [Recovery action]
### Step 2: [Action]
...
## Verification
- [ ] [Check 1]
- [ ] [Check 2]
## Rollback
If the procedure fails:
1. [Rollback step 1]
2. [Rollback step 2]
## Escalation
- L1: [Contact]
- L2: [Contact]
- L3: [Contact]
```
### Step 5: Apply Runbook Best Practices
- **Executable commands**: Copy-pasteable, tested
- **No ambiguity**: One interpretation per step
- **Verification steps**: How to confirm success
- **Rollback plan**: Every procedure is reversible
- **Escalation path**: Who to call when stuck
### Step 6: Format & Save
Save to: `docs/runbooks/{system}-{procedure}.md`
Present options to user:
1. Generate related runbooks
2. Create monitoring dashboard config
3. Add architecture diagram
## Quality Checklist
- [ ] Clear trigger/when to use
- [ ] Prerequisites listed
- [ ] Commands are copy-pasteable
- [ ] Expected results documented
- [ ] Rollback procedure included
- [ ] Escalation contacts provided
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 |