MR
Mayur Rathi
@sickn33
⭐ 47.3k GitHub stars

runbook-creation

runbook-creation is an code AI skill with a core value of Create operational runbooks and standard operating procedures. It helps developers solve real-world problems in the code domain, boosting efficiency, automating repetitive tasks, and optimizing workflows.

Create operational runbooks and standard operating procedures. Document troubleshooting guides and recovery procedures. Use when documenting operational knowledge.

Last verified on: 2026-10-06

Quick Facts

Category code
Works With Claude
Source sickn33/antigravity-awesome-skills
Stars ⭐ 47.3k
Last Verified 2026-10-06
Risk Level Low
mkdir -p ./skills/runbook-creation && curl -sfL https://raw.githubusercontent.com/sickn33/antigravity-awesome-skills/main/skills/runbook-creation/SKILL.md -o ./skills/runbook-creation/SKILL.md

Run in terminal / PowerShell. Requires curl (Unix) or PowerShell 5+ (Windows).

Skill Content

# Runbook Creation


Create effective operational runbooks, standard operating procedures, and

troubleshooting guides that any on-call engineer can follow under pressure.


Runbook Template — Full Structure


text
# Runbook: [Service / Process Name]

**Owner:** [Team or individual]
**Last Reviewed:** YYYY-MM-DD
**Version:** X.Y
**Severity if unavailable:** SEV[1-4]

---

## Overview

Brief description of the service, why this runbook exists, and when to
use it.

## Prerequisites

- [ ] Required access / IAM role: [details]
- [ ] Tools installed: [kubectl, aws-cli, psql, etc.]
- [ ] VPN connected to [environment]
- [ ] Communication channel open: [Slack #channel]

## Procedure

### Step 1 — [Action Name]

[Explanation of what this step does and why.]

# command here

text

**Expected output:** [describe what success looks like]

### Step 2 — [Action Name]

# command here

text

**Expected output:** [description]

*(Continue with numbered steps...)*

## Verification

How to confirm the procedure succeeded:

- [ ] [Check 1 — e.g., health endpoint returns 200]
- [ ] [Check 2 — e.g., no errors in logs for 5 minutes]
- [ ] [Check 3 — e.g., metrics return to baseline]

## Rollback

If the procedure fails or causes unexpected issues:

### Rollback Step 1

# rollback command

text

### Rollback Step 2

# rollback command

text

## Troubleshooting

| Symptom | Likely Cause | Resolution |
|---------|-------------|------------|
| [symptom 1] | [cause] | [fix] |
| [symptom 2] | [cause] | [fix] |

## Escalation

If unresolved after [X] minutes:
- **Primary:** @[team-lead] — [phone/Slack]
- **Secondary:** @[manager] — [phone/Slack]

## Related Runbooks

- [Link to related runbook 1]
- [Link to related runbook 2]

## Change Log

| Date | Author | Change |
|------|--------|--------|
| YYYY-MM-DD | [Name] | Initial version |

Overview


Failover the primary PostgreSQL instance to the synchronous replica when

the primary is unreachable or degraded. This runbook covers both planned

(maintenance) and unplanned (emergency) failover.


Prerequisites


- [ ] DBA or SRE-level access to primary and replica hosts

- [ ] `psql` client installed (v14+)

- [ ] VPN connected to production network

- [ ] Slack channel #db-ops open

- [ ] Confirm replica is in sync: replication lag < 1 MB


Procedure


Step 1 — Verify Replica Health


bash
psql -h replica.db.internal -U dba -d postgres -c \
  "SELECT pg_is_in_recovery(), pg_last_wal_replay_lsn();"

**Expected output:** `pg_is_in_recovery = t`, LSN advancing.


Step 2 — Stop Application Writes


bash
kubectl scale deployment api-server --replicas=0 -n production
kubectl scale deployment worker --replicas=0 -n production

**Expected output:** Deployments scaled to 0 pods.


Step 3 — Confirm Write Quiesce


bash
psql -h primary.db.internal -U dba -d postgres -c \
  "SELECT count(*) FROM pg_stat_activity WHERE state = 'active' AND query !~ 'pg_stat';"

**Expected output:** Count = 0 (no active queries).


Step 4 — Promote Replica


bash
psql -h replica.db.internal -U dba -d postgres -c "SELECT pg_promote();"

Wait up to 30 seconds, then confirm:


bash
psql -h replica.db.internal -U dba -d postgres -c "SELECT pg_is_in_recovery();"

**Expected output:** `pg_is_in_recovery = f` (no longer a replica).


Step 5 — Update DNS


bash
aws route53 change-resource-record-sets \
  --hosted-zone-id Z1234567890 \
  --change-batch '{
    "Changes": [{
      "Action": "UPSERT",
      "ResourceRecordSet": {
        "Name": "db.internal.example.com",
        "Type": "CNAME",
        "TTL": 60,
        "ResourceRecords": [{"Value": "replica.db.internal"}]
      }
    }]
  }'

Step 6 — Restart Application


bash
kubectl scale deployment api-server --replicas=6 -n production
kubectl scale deployment worker --replicas=4 -n production

Verification


- [ ] `psql -h db.internal.example.com -c "SELECT 1;"` returns successfully

- [ ] Applic

🎯 Best For

  • Technical writers
  • API documentation teams
  • UI designers
  • Product designers
  • Claude users

💡 Use Cases

  • Generating JSDoc/TSDoc comments
  • Writing README files for new projects
  • Generating component mockups
  • Creating design system tokens

📖 How to Use This Skill

  1. 1

    Install the Skill

    Copy the install command from the Terminal tab and run it. The SKILL.md file downloads to your local skills directory.

  2. 2

    Load into Your AI Assistant

    Open Claude and reference the skill. Paste the SKILL.md content or use the system prompt tab.

  3. 3

    Apply runbook-creation to Your Work

    Open your project in the AI assistant and ask it to apply the skill. Start with a small module to verify the output quality.

  4. 4

    Review and Refine

    Review AI suggestions before committing. Run tests, check for regressions, and iterate on the skill output.

❓ Frequently Asked Questions

Does it follow my documentation style?

Most documentation skills respect existing style. Provide a style guide or example in your prompt.

Does this work with Figma?

Some design skills integrate with Figma plugins. Check the Works With section for supported tools.

Is runbook-creation compatible with Cursor and VS Code?

Yes — this skill works with any AI coding assistant including Cursor, VS Code with Copilot, and JetBrains IDEs.

Do I need specific dependencies for runbook-creation?

Check the install command and Works With section. Most code skills only require the AI assistant and your codebase.

How do I install runbook-creation?

Copy the install command from the Terminal tab and run it. The skill downloads to ./skills/runbook-creation/SKILL.md, ready to use.

⚠️ Common Mistakes to Avoid

Auto-generating without reviewing

AI documentation can contain inaccuracies. Always verify technical accuracy.

Skipping usability testing

AI-generated designs should be validated with real users before development.

Skipping validation

Always test AI-generated code changes, even for simple refactors.

Missing dependency updates

Check if the skill requires updated dependencies or new packages.

🔗 Related Skills