Documenter l'exploitation¶
Runbooks, CMDB, diagrammes d'architecture, wiki ops et documentation opérationnelle.
graph LR
A["Fondamentaux"] --> B["Runbooks"]
B --> C["Architecture"]
C --> D["Procedures"]
D --> E["Wiki"]
E --> F["Automatisation"]
F --> G["Cas avances"]Ce que vous allez apprendre¶
À la fin de ce tutoriel, vous serez capable de :
- Comprendre les types de documentation ops et cultiver une documentation vivante
- Écrire des runbooks clairs et actionables pour les équipes d'astreinte
- Cartographier l'architecture avec des diagrammes C4, des CMDB et du docs-as-code
- Rediger des procédures opérationnelles standardisees (déploiement, maintenance, DR)
- Organiser un wiki ops efficace qui ne devient pas un cimetiere
- Automatiser la génération et la validation de documentation dans la CI
- Documenter pour la conformité (ISO 27001, HDS) et mesurer la qualité documentaire
Prérequis¶
| Prérequis | Détail |
|---|---|
| Infrastructure | Expérience d'exploitation (système, cloud, ou réseau) |
| Git | Notions de base pour le docs-as-code |
| Markdown | Syntaxe de base |
Parcours¶
| Section | Contenu |
|---|---|
| Fondamentaux | Types de documentation ops, documentation vivante vs obsolète, culture de l'écrit |
| Runbooks | Structure, templates, niveaux de détail, runbooks d'astreinte |
| Architecture et cartographie | C4, CMDB, dependency mapping, Mermaid, Structurizr |
| Procedures operationnelles | Déploiement, maintenance, bascule DR, onboarding ops, checklists |
| Wiki et knowledge base | Organisation, conventions, revue périodique, éviter le wiki-cimetiere |
| Automatisation de la doc | terraform-docs, ansible-doc, CI, linting, changelog infra |
| Cas avances | Conformité (ISO 27001, HDS), multi-équipes, ADR infra, métriques qualité |