Retour au laboratoire

DAILYOPS / DOCUMENTATION AS CODE

Garder la connaissance opérationnelle proche des systèmes qu’elle doit décrire.

OpsDoc transforme les snapshots d’infrastructure en documentation Markdown versionnée dans Git, avec une provenance explicite (live ou mock) et des états de fraîcheur au lieu de pages silencieusement obsolètes.

LE PROBLÈME OPÉRATIONNEL

La connaissance se dégrade quand plus personne ne sait ce qui est encore vrai.

Les runbooks, notes de topologie et décisions s’écartent des systèmes qu’ils décrivent — et personne ne sait quelle page est encore fiable.

CE QUE LE SYSTÈME REND POSSIBLE

OpsDoc / 03
01

Provenance des snapshots

Chaque document porte son mode (live/mock), son statut, son horodatage et son identifiant de snapshot — aucune source cachée.

02

États de fraîcheur

FRESH, DRIFTED, STALE, UNVERIFIED, SOURCE_UNAVAILABLE, MISSING, ERROR — la porte de vérification nomme ce qui n’est plus fiable.

03

Une source, trois surfaces

Générer, vérifier et lire via la CLI, l’API et l’interface web ; Git reste la source de vérité.

PREUVE VISUELLE

Une documentation incorporée au système opérationnel.

Emplacement réservé à un espace de documentation, une revue de fraîcheur et une vue du graphe.

Les captures seront intégrées ici lorsqu’elles seront prêtes.

POSITION DE CONSTRUCTION

“Un document utile change avec le travail qu’il soutient.”

OpsDoc explore ce que devient la documentation lorsqu’on la traite comme une partie active et responsable des opérations.

RESSOURCES

Documentation avant dépôt.

Besoin d'un coup de main ? Guides et sujets techniques.