Documentation Technique
Rédigez une documentation technique claire et maintenable pour différents publics et usages.
Types de Documents
README
- Ce que c'est et pourquoi ça existe
- Démarrage rapide (< 5 minutes pour le premier succès)
- Configuration et utilisation
- Guide de contribution
Documentation API
- Référence des endpoints avec exemples de requête/réponse
- Authentification et codes d'erreur
- Limites de débit et pagination
- Exemples SDK
Runbook
- Quand utiliser ce runbook
- Prérequis et accès nécessaires
- Procédure étape par étape
- Étapes de rollback
- Chemin d'escalade
Document Architecture
- Contexte et objectifs
- Conception haut niveau avec diagrammes
- Décisions clés et compromis
- Flux de données et points d'intégration
Guide Onboarding
- Configuration de l'environnement
- Systèmes clés et comment ils se connectent
- Tâches courantes avec procédures
- Qui demander pour quoi
Principes
- Écrivez pour le lecteur — Qui lit ça et de quoi a-t-il besoin ?
- Commencez par l'information la plus utile — Ne cachez pas l'essentiel
- Montrez, ne dites pas — Exemples de code, commandes, captures d'écran
- Tenez à jour — Une doc obsolète est pire que pas de doc
- Créez des liens, ne dupliquez pas — Référencez d'autres docs au lieu de les copier