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-documentation.md
View on GitHub# Deployment: Documentation Structure
---
TOKEN_BUDGET: 380
TIER: 3
LOAD_TRIGGER: On-demand when creating deployment documentation
DEPENDENCIES: None
---
## 6.1 Deployment Documentation
### Essential Sections
1. **System Requirements**: OS, runtime versions, dependencies
2. **Installation Steps**: Step-by-step with commands
3. **Configuration**: Environment variables, config files
4. **Database Setup**: Schema, migrations, seeding
5. **Deployment Topology**: Servers, load balancers, firewalls
6. **Monitoring**: Logs, metrics, health checks
7. **Backup and Recovery**: Procedures and schedules
---
### Example Deployment Guide
```markdown
## Deployment: Production Environment
### Prerequisites
- Ubuntu 22.04 LTS
- Docker 24.0+
- PostgreSQL 15+
- 4 vCPU, 16GB RAM minimum
### Installation
**Step 1: Clone repository**
```bash
git clone https://github.com/org/taskmanager.git
cd taskmanager
```
**Step 2: Configure environment**
```bash
cp .env.example .env
# Edit .env with production values
nano .env
```
**Step 3: Build and start services**
```bash
docker-compose -f docker-compose.prod.yml up -d
```
**Step 4: Run database migrations**
```bash
docker exec taskmanager-api npm run migrate
```
**Step 5: Verify deployment**
```bash
curl https://api.taskmanager.com/health
# Expected: {"status": "healthy"}
```
### Configuration
**Environment Variables:**
| Variable | Description | Example |
|----------|-------------|---------|
| `DATABASE_URL` | PostgreSQL connection string | `postgres://user:pass@db:5432/tasks` |
| `JWT_SECRET` | Secret for signing tokens | `generated-secret-key-here` |
| `REDIS_URL` | Redis cache connection | `redis://cache:6379` |
| `LOG_LEVEL` | Logging verbosity | `info` |
| `PORT` | API server port | `8080` |
**Config Files:**
- `config/production.yml`: Feature flags, service endpoints
- `config/database.yml`: Connection pool settings
- `config/logging.yml`: Log formats and destinations
### Database Setup
**Migrations:**
```bash
# Apply all pending migrations
npm run migrate
# Rollback last migration
npm run migrate:rollback
```
**Seeding:**
```bash
# Seed initial data (admin users, default settings)
npm run seed
```
### Monitoring
**Health Checks:**
- Endpoint: `GET /health`
- Expected: 200 OK with `{"status": "healthy"}`
- Frequency: Every 30 seconds
**Logs:**
- Location: `/var/log/taskmanager/`
- Rotation: Daily, keep 30 days
- Format: JSON structured logs
**Metrics:**
- Prometheus endpoint: `/metrics`
- Grafana dashboard: http://grafana.example.com/d/taskmanager
### Backup and Recovery
**Database Backups:**
- Frequency: Daily at 2 AM UTC
- Retention: 30 days
- Location: S3 bucket `s3://backups.taskmanager.com/db/`
**Restore Procedure:**
```bash
# Download latest backup
aws s3 cp s3://backups.taskmanager.com/db/latest.sql.gz .
# Restore to database
gunzip latest.sql.gz
psql -h db.example.com -U admin -d tasks < latest.sql
```
```
---
**End of Deployment Documentation 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 |