/runbook

Si vous voyez des placeholders non familiers ou avez besoin de vérifier quels outils sont connectés, consultez CONNECTORS.md.

Créez un runbook opérationnel étape par étape pour une tâche ou procédure récurrente.

Utilisation

/runbook $ARGUMENTS

Sortie

## Runbook: [Task Name]
**Owner:** [Team/Person] | **Frequency:** [Daily/Weekly/Monthly/As Needed]
**Last Updated:** [Date] | **Last Run:** [Date]

### Purpose
[What this runbook accomplishes and when to use it]

### Prerequisites
- [ ] [Access or permission needed]
- [ ] [Tool or system required]
- [ ] [Data or input needed]

### Procedure

#### Step 1: [Name]

[Exact command, action, or instruction]

**Expected result:** [What should happen]
**If it fails:** [What to do]

#### Step 2: [Name]

[Exact command, action, or instruction]

**Expected result:** [What should happen]
**If it fails:** [What to do]

### Verification
- [ ] [How to confirm the task completed successfully]
- [ ] [What to check]

### Troubleshooting
| Symptom | Likely Cause | Fix |
|---------|-------------|-----|
| [What you see] | [Why] | [What to do] |

### Rollback
[How to undo this if something goes wrong]

### Escalation
| Situation | Contact | Method |
|-----------|---------|--------|
| [When to escalate] | [Who] | [How to reach them] |

### History
| Date | Run By | Notes |
|------|--------|-------|
| [Date] | [Person] | [Any issues or observations] |

Si les connecteurs sont disponibles

Si ~~knowledge base est connecté :

• Cherchez les runbooks existants à mettre à jour plutôt que d'en créer de zéro
• Publiez le runbook complété dans votre wiki opérationnel

Si ~~ITSM est connecté :

• Liez le runbook aux types d'incidents et demandes de changement associés
• Pré-remplissez automatiquement les contacts d'escalade à partir des plannings on-call

Conseils

1. Soyez terriblement précis — « Exécuter le script » n'est pas une étape. « Exécuter python sync.py --prod --dry-run depuis le serveur ops » l'est.
2. Incluez les modes de défaillance — Qu'est-ce qui peut mal tourner à chaque étape et que faire à ce sujet.
3. Testez le runbook — Faites-le suivre par quelqu'un d'unfamiliar avec le processus. Corrigez où ils se bloquent.