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-runbooks.md
View on GitHub# Deployment: Runbooks and Operational Guides
---
TOKEN_BUDGET: 280
TIER: 3
LOAD_TRIGGER: On-demand when creating runbooks or operational procedures
DEPENDENCIES: 06-deployment-documentation.md
---
## 6.3 Runbooks and Operational Guides
A **runbook** is a step-by-step procedure for handling operational tasks or incidents.
### Runbook Template
```markdown
# Runbook: Database Failover Procedure
## When to Use
When the primary database becomes unresponsive or corrupted.
## Prerequisites
- Access to AWS RDS console
- `psql` client installed
- VPN connected to production network
## Severity
š“ **Critical** - Affects all users
## Steps
### 1. Verify Issue
```bash
psql -h primary.db.com -U admin -c "SELECT 1"
```
**Expected**: Query should return in <100ms
**If timeout**: Proceed to failover
### 2. Promote Read Replica
- Log into AWS RDS console: https://console.aws.amazon.com/rds
- Navigate to Databases ā Select `taskmanager-replica-1`
- Actions ā "Promote read replica"
- Confirm promotion
- **Wait**: 2-5 minutes for promotion to complete
### 3. Update Application Config
```bash
kubectl set env deployment/api \
DATABASE_URL=postgres://admin:pass@replica.db.com:5432/tasks
```
### 4. Verify Application Health
```bash
curl https://api.taskmanager.com/health
```
**Expected**: `{"status": "healthy"}`
### 5. Notify Team
Post in #incidents Slack channel:
```
š“ Database failover completed
- Old primary: primary.db.com (down)
- New primary: replica.db.com (promoted)
- Application: healthy
- Action: Investigate root cause
```
## Rollback
If issues occur:
```bash
kubectl set env deployment/api \
DATABASE_URL=postgres://admin:pass@primary.db.com:5432/tasks
```
## Post-Incident
- [ ] Document root cause
- [ ] Review logs from failed primary
- [ ] Update monitoring alerts
- [ ] Schedule post-mortem meeting
```
### Types of Runbooks
1. **Incident Response**: Database failover, service restart, rollback deployment
2. **Routine Operations**: Backups, log rotation, certificate renewal
3. **Disaster Recovery**: Full system restore, data center failover
4. **Scaling**: Add capacity, resize databases, update autoscaling rules
### Best Practices
1. **Test Regularly**: Run through runbooks during game days
2. **Keep Updated**: Review after every incident
3. **Make Them Executable**: Use scripts where possible
4. **Include Rollback**: Every action should have an undo
5. **Specify Timing**: How long should each step take?
6. **Add Verification**: How do you know the step worked?
---
**End of Runbooks 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 |