- Documentation d'architecture : contexte et objectifs, schéma (le modèle C4 : contexte, conteneurs, composants), choix et alternatives écartées, flux, sécurité, exploitation. Les décisions importantes se tracent dans des ADR (Architecture Decision Records) courts.
- Procédure d'exploitation (runbook) : quand l'utiliser (symptôme, alerte), prérequis et droits, étapes numérotées avec commandes copiables et résultat attendu à chaque étape, vérification finale, retour arrière, contacts d'escalade.
- Guide utilisateur : orienté tâche (« Comment… »), captures annotées, vocabulaire de l'utilisateur.
- README d'un dépôt : à quoi sert le projet, comment l'installer, le lancer, le tester, le déployer, et qui contacter.
# Runbook : espace disque critique sur srv-app01
Déclencheur : alerte « /var > 90 % » (Zabbix)
Prérequis : accès sudo sur srv-app01
1. Identifier les plus gros dossiers :
sudo du -xh /var --max-depth=2 | sort -h | tail
Attendu : /var/log/app en tête
2. Compresser les journaux de plus de 7 jours :
sudo find /var/log/app -name "*.log" -mtime +7 -exec gzip {} \;
3. Vérifier : df -h /var → attendu < 80 %
Si le problème persiste : escalader à l'équipe applicative (astreinte N2)