runbook
Create operational runbooks that provide standardized procedures for deployment, operation, maintenance, troubleshooting, recovery, and incident response.
- License 许可
- MIT
- 最近更新
- 2026-11-14
- Stars
- ★ 0
- Forks
- 0
01 前言 Front Matter
- name
- runbook
- author
- AI Business OS
- license
- MIT
- version
- 1.0.0
- category
- template
- priority
- required
- description
- Create operational runbooks that provide standardized procedures for deployment, operation, maintenance, troubleshooting, recovery, and incident response.
03 SKILL.md 正文
Runbook
Purpose
This skill creates operational runbooks that document repeatable procedures for operating, maintaining, troubleshooting, and recovering software systems.
Runbooks should enable engineers to perform operational tasks safely and consistently.
When to Use
Execute when:
- Preparing production operations
- Documenting deployment procedures
- Creating maintenance guides
- Defining recovery procedures
- Supporting on-call engineers
- Standardizing operational tasks
Objectives
Produce runbooks that are:
- Clear
- Repeatable
- Reliable
- Actionable
- Easy to follow
Inputs
Expected inputs:
- System Architecture
- Deployment Process
- Infrastructure Documentation
- Monitoring Configuration
- Incident History
- Operational Requirements
Runbook Structure
Generate the following sections:
- Overview
- Purpose
- Scope
- Prerequisites
- Roles & Responsibilities
- Required Tools
- Step-by-Step Procedures
- Verification
- Rollback
- Troubleshooting
- Escalation
- References
Operational Procedures
Document:
- Startup
- Shutdown
- Deployment
- Configuration Changes
- Backup
- Restore
- Maintenance
Provide numbered steps for each procedure.
Troubleshooting
Include:
- Common Issues
- Symptoms
- Root Causes
- Resolution Steps
- Verification
- Escalation Criteria
Recovery Procedures
Define:
- Failure Detection
- Recovery Steps
- Rollback Process
- Data Recovery
- Service Validation
Ensure recovery procedures are tested regularly.
Validation Checklist
Verify:
- Procedures complete
- Commands validated
- Rollback documented
- Troubleshooting included
- Escalation contacts defined
- References updated
Failure Conditions
Stop if:
- Procedures are unverified
- Recovery steps are incomplete
- Required tools are unavailable
- Dependencies are undocumented
- Validation steps are missing
Outputs
Generate:
- Operational Runbook
- Recovery Guide
- Troubleshooting Guide
- Maintenance Checklist
Rules
- Write step-by-step instructions.
- Validate every procedure.
- Include rollback steps.
- Keep documentation current.
- Minimize operational ambiguity.
Success Criteria
This skill succeeds when:
- operations are repeatable
- incidents can be resolved consistently
- recovery procedures are reliable
- operational risk is reduced
Related Skills
- devops-engineer
- release-note
- incident-report
- postmortem
- changelog
Version History
| Version | Date | Description |
|---|---|---|
| 1.0.0 | 2026-07-10 | Initial release |
04 同仓库更多 Skills
rollback
Plan, validate, and execute safe rollback procedures to restore a stable system state when deployments introduce critical issues.
release-note
Create clear, concise, and stakeholder-friendly release notes that communicate new features, improvements, fixes, breaking changes, and operational guidance for each release.
monitoring
Continuously observe application health, performance, reliability, and business metrics after deployment to detect issues early and support operational excellence.
maintenance
Maintain, improve, and support production systems after release through continuous monitoring, issue resolution, updates, and operational excellence.
deployment
Plan, validate, and execute application deployments safely and consistently across environments while minimizing downtime and deployment risk.
changelog
Maintain a structured, accurate, and versioned changelog that records all notable changes made to the project across releases.