Purpose
One sentence: what this runbook does and when to use it.
Free Process Template
Daily procedures for [system] maintenance
Use this template to daily procedures for [system] maintenance.
| Field | Details |
|---|---|
| Category | Process |
| Owner | [Team or owner] |
| Version | [Version number] |
| Effective Date | [Date] |
| Review Cycle | [Monthly / Quarterly / Annual / Event-based] |
| Status | [Draft / In Review / Approved] |
One sentence: what this runbook does and when to use it.
| Item | Details | Owner | Status |
|---|---|---|---|
| [Item or requirement] | [Describe the relevant detail, evidence, or decision] | [Owner] | [Open / Complete] |
| [Item or requirement] | [Describe the relevant detail, evidence, or decision] | [Owner] | [Open / Complete] |
[Add context, assumptions, exceptions, evidence links, screenshots, calculations, or reviewer comments.]
Required access, credentials, and tools in checklist format.
| Item | Details | Owner | Status |
|---|---|---|---|
| [Item or requirement] | [Describe the relevant detail, evidence, or decision] | [Owner] | [Open / Complete] |
| [Item or requirement] | [Describe the relevant detail, evidence, or decision] | [Owner] | [Open / Complete] |
[Add context, assumptions, exceptions, evidence links, screenshots, calculations, or reviewer comments.]
Commands to run before starting with expected output.
| Item | Details | Owner | Status |
|---|---|---|---|
| [Item or requirement] | [Describe the relevant detail, evidence, or decision] | [Owner] | [Open / Complete] |
| [Item or requirement] | [Describe the relevant detail, evidence, or decision] | [Owner] | [Open / Complete] |
[Add context, assumptions, exceptions, evidence links, screenshots, calculations, or reviewer comments.]
Numbered steps with exact commands, expected output, and wait conditions.
| Item | Details | Owner | Status |
|---|---|---|---|
| [Item or requirement] | [Describe the relevant detail, evidence, or decision] | [Owner] | [Open / Complete] |
| [Item or requirement] | [Describe the relevant detail, evidence, or decision] | [Owner] | [Open / Complete] |
[Add context, assumptions, exceptions, evidence links, screenshots, calculations, or reviewer comments.]
Commands to confirm success.
| Item | Details | Owner | Status |
|---|---|---|---|
| [Item or requirement] | [Describe the relevant detail, evidence, or decision] | [Owner] | [Open / Complete] |
| [Item or requirement] | [Describe the relevant detail, evidence, or decision] | [Owner] | [Open / Complete] |
[Add context, assumptions, exceptions, evidence links, screenshots, calculations, or reviewer comments.]
Exact steps to undo changes.
| Item | Details | Owner | Status |
|---|---|---|---|
| [Item or requirement] | [Describe the relevant detail, evidence, or decision] | [Owner] | [Open / Complete] |
| [Item or requirement] | [Describe the relevant detail, evidence, or decision] | [Owner] | [Open / Complete] |
[Add context, assumptions, exceptions, evidence links, screenshots, calculations, or reviewer comments.]
Escalation contact table. Use code blocks for ALL commands. Assume an experienced engineer reader.
| Item | Details | Owner | Status |
|---|---|---|---|
| [Item or requirement] | [Describe the relevant detail, evidence, or decision] | [Owner] | [Open / Complete] |
| [Item or requirement] | [Describe the relevant detail, evidence, or decision] | [Owner] | [Open / Complete] |
[Add context, assumptions, exceptions, evidence links, screenshots, calculations, or reviewer comments.]
Document review conclusions, approvals, unresolved items, and next review date.
| Role | Name | Date | Notes |
|---|---|---|---|
| Preparer | [Name] | [Date] | [Notes] |
| Reviewer | [Name] | [Date] | [Notes] |
| Approver | [Name] | [Date] | [Notes] |
Template Structure
Use this process template as a starting point, then customize each section to match your internal workflow, evidence, and signoff needs.
One sentence: what this runbook does and when to use it.
Required access, credentials, and tools in checklist format.
Commands to run before starting with expected output.
Numbered steps with exact commands, expected output, and wait conditions.
Commands to confirm success.
Exact steps to undo changes.
Escalation contact table. Use code blocks for ALL commands. Assume an experienced engineer reader.
Write an Operational Runbook in a terse, precise tone. Every word should serve a purpose. Structure with:
One sentence: what this runbook does and when to use it.
Required access, credentials, and tools in checklist format.
Commands to run before starting with expected output.
Numbered steps with exact commands, expected output, and wait conditions.
Commands to confirm success.
Exact steps to undo changes.
Escalation contact table.
Use code blocks for ALL commands. Assume an experienced engineer reader.
Rotate Elasticsearch indexes monthly to maintain query performance and manage disk usage. Run on the 1st of each month at 03:00 UTC.
production clustersecret/es/admin)# Verify cluster health
curl -s "https://es.internal:9200/_cluster/health" | jq '.status'
# Expected: "green"
# Check current index size
curl -s "https://es.internal:9200/_cat/indices/logs-*?h=index,store.size&s=index:desc" | head -3
curl -XPUT "https://es.internal:9200/logs-$(date -d '+1 month' +%Y.%m)" \
-H 'Content-Type: application/json' -d @/ops/es-index-template.json
curl -XPOST "https://es.internal:9200/_aliases" -H 'Content-Type: application/json' -d '{
"actions": [
{"remove": {"index": "logs-'$(date +%Y.%m)'", "alias": "logs-write"}},
{"add": {"index": "logs-'$(date -d '+1 month' +%Y.%m)'", "alias": "logs-write"}}
]
}'
curator --config /ops/curator.yml /ops/actions-archive.yml
curl -s "https://es.internal:9200/_alias/logs-write" | jq 'keys'
# Expected: ["logs-YYYY.MM"] (next month)
Record a walkthrough, training session, or process demonstration. Docsie AI turns it into structured documentation using this template as the starting framework.
Use the template manually, or let Docsie generate the first draft from source footage.
Process for implementing [change] with rollback
Response procedures for [incident type]
Security procedures for [threat] detection and response
Step-by-step process for [task]
Template FAQ
Common questions about using and generating a operational Runbook.
Q: What is a operational Runbook?
A: A operational Runbook is a structured document for daily procedures for [system] maintenance.
Q: Can I download this operational Runbook as Word or PDF?
A: Yes. This page includes free downloads in DOCX, PDF, and Markdown formats so you can edit, share, or import the template into your documentation system.
Q: Can Docsie generate this from a video?
A: Yes. Upload a process walkthrough, training recording, or screen capture to Docsie, then use this template structure to generate a first draft automatically.