Constituer votre boîte à outils
Référence
Modèles, check-lists et exemples concrets prêts à l'emploi pour la documentation technique — copiez-les pour partir d'une base fonctionnelle plutôt que d'une page blanche.
Des modèles, check-lists et exemples à copier directement dans votre propre projet. Chaque élément est clairement identifié comme modèle (un point de départ à adapter) ou exemple concret (une illustration aboutie à étudier).
Les modèles ci-dessous s’appuient sur la typologie de l’information : Concepts, Tâches et Références.
Modèle d'article conceptDéfinition, pourquoi c'est important, principes clés, exemples, compromis.
Modèle d'article tâcheObjectif, prérequis, étapes, résultat attendu, dépannage.
Modèle d'article référenceAperçu, syntaxe, paramètres, exemples, limitations.
Plan de projet documentaireObjectif, public, périmètre, format, critères de succès, calendrier.
Demande de revue documentaireCadrer une revue pour qu'elle soit réellement effectuée.
Check-lists
Section intitulée « Check-lists »Qualité documentaireÀ exécuter avant de fusionner tout changement documentaire.
Revue techniqueCe qu'un relecteur expert métier doit et ne doit pas vérifier.
Préparation à la mise en productionUn jalon pour livrer la documentation avec une version du produit.
Migration documentaireChanger de format ou de plateforme sans perdre de contenu ni d'URL.
Adoption du docs-as-codeFormat, gestion de versions, CI/CD et préparation de l'équipe.
Audit documentaireRepérer les pages orphelines, doublons et contenus obsolètes.
Exemples concrets
Section intitulée « Exemples concrets »Une page Markdown bien structuréeUn article concept annoté, expliquant chaque choix structurel.
Une architecture de dépôt documentaireContenu langue-en-premier, séparé de l'outillage et des assets.
Un workflow docs-as-code basiqueUn changement, de la branche à la production, annoté étape par étape.
Un workflow de revue documentaireScinder revue technique et revue éditoriale, et pourquoi.
Un pipeline CI/CD concretBuild, tests, vérification de liens, prévisualisation, déploiement — annoté étape par étape.
Documentation d’API
Section intitulée « Documentation d’API »Modèle de documentation d'APIUn endpoint par page : méthode, paramètres, requête/réponse, codes d'erreur.