Olivier Carrère · Rédacteur technique senior : Pratique de la rédaction technique
Un portfolio et une bibliothèque documentaires : méthodes, études de cas, exemples détaillés et projets documentaires, en français et en anglais, maintenus dans Git depuis 2014.
Docs-as-code · DITA et rédaction structurée · Architecture documentaire · Documentation développeur et d'API · Automatisation et CI/CD
Disponible pour une nouvelle opportunité à partir d’octobre 2026
Suivre le parcours méthodique en 6 étapes pour maîtriser la documentation de bout en bout.
Un besoin spécifique ? Utilisez la recherche (⌘K), parcourez par thème, par type d’information ou partez de votre objectif.
Parcours guidé
Six parcours dans le manuel
Lisez-les dans l’ordre pour une méthode complète, ou allez directement au parcours dont vous avez besoin.
Comprendre la documentation
Pourquoi l’architecture documentaire compte : valeur, maturité, types d’information.
Construire un processus documentaire
Le processus étape par étape, de la définition du projet à la livraison.
Adopter le docs-as-code
Git, conception du référentiel, branches, CI/CD et contrôles automatisés.
Choisir un modèle de rédaction
Rédaction structurée, DITA, Markdown, réutilisation du contenu et formats.
Constituer votre boîte à outils
Modèles, check-lists et exemples concrets à réutiliser.
Automatisation et techniques spécialisées
Jinja, Python, sed, Sphinx/ReST, XSL-FO : techniques spécialisées et historiques.
Travaux choisis
Études de cas et projets
Documentation d’un produit logiciel en DITA XML, citée par la presse comme un point fort du produit.
Une documentation bilingue maintenue sous Git depuis 2014 et compilée en CI à chaque modification.
Les mêmes sources servies aux scripts et agents IA sous forme de llms.txt, Markdown et JSON.
Historique du site
Comment la documentation a évolué
Découvrez comment les commits ont façonné le portfolio documentaire : chaque modification rejoint une section du manuel, puis ses pages.
Diagramme simplifié de l’historique Git du site, du commit à la section puis à la page : 4 commits rejoignent 3 sections (Construire un processus documentaire, Choisir un modèle de rédaction, Automatisation et techniques spécialisées), puis 5 pages (Validation et contrôle qualité, Mener un projet de bout en bout, Formats structurés et non structurés, Du document à la base documentaire modulaire, sed : modifiez votre texte sans ouvrir vos fichiers). La largeur de chaque flux correspond au nombre de fichiers de documentation modifiés.
Expertise
Domaines d’expertise
Chaque domaine renvoie aux articles, études de cas et exemples concrets qui en témoignent.
La documentation sous Git à côté du produit : branches, revue par pull request et conception du référentiel.
DITA XML orienté topics, réutilisation du contenu par conref et texte conditionnel, avec une étude de cas produit.
Typologie de l’information, contenu modulaire, structure du dépôt et modèles d’articles cohérents.
Modèles de référence d’API, une API documentaire lisible par les machines et la revue technique avec les ingénieurs.
Pipelines de compilation, de vérification et de publication, et contenu généré à partir des données avec Python et Jinja.
Une composante du workflow documentaire, toujours avec une relecture humaine : traduction assistée par l’IA, assistant documentaire fondé sur les sources et API documentaire pour les agents IA.
Partir de votre objectif
Que cherchez-vous à faire ?
Définir l’audience, le périmètre et les livrables avant d’écrire le moindre mot.
Voir toute la chaîne de production, de la collecte d’information à la livraison.
Gérer la documentation comme du code : gestion de versions, revue et CI/CD.
Déterminer le degré de structure dont votre contenu a besoin, du Markdown à DITA.
Auditer l’existant : pages orphelines, doublons et contenus obsolètes.
Générer, vérifier et publier la documentation automatiquement à chaque modification.
Prêt à l’emploi
Ressources pratiques
Modèles, check-lists et exemples concrets à reprendre dans votre propre projet.
À exécuter avant de fusionner tout changement documentaire.
Un changement, de la branche à la production, annoté étape par étape.
Un endpoint par page : méthode, paramètres, requête/réponse, codes d’erreur.
Objectif, public, périmètre, format, critères de succès, calendrier.
Assistant documentaire IA
Explorer la documentation
Décrivez votre besoin avec vos propres mots. Les réponses sont générées uniquement à partir du contenu de ce site, avec des liens vers les pages utilisées. Pour exploiter ce contenu dans vos propres outils ou agents, voir l’API documentaire.
Réponse
Sources et approfondissement
Explorer & Trouver
Parcourir toute la documentation
Accédez aux ressources selon trois perspectives complémentaires : les 6 parcours du manuel, les types d’information ou les thèmes transversaux.
Comprendre la documentation6 pages
Construire un processus documentaire10 pages
Adopter le docs-as-code11 pages
Choisir un modèle de rédaction19 pages
- Vue d'ensemble
- Rédaction structurée
- DITA
- Du document à la base documentaire modulaire
- Formats source et cible
Constituer votre boîte à outils18 pages
- Vue d'ensemble
- Modèles
- Check-lists
- Exemples concrets
- Documentation d'API
Automatisation et techniques spécialisées11 pages
Explorer la référence3 pages
API documentaire et IA2 pages
ConceptCompréhension, contexte, architecture et modèles mentaux pour assimiler les principes.32 pages
- Cas concrets d’utilisation de DITA XMLChoisir un modèle de rédactionDITA
- Collecte de l’informationConstruire un processus documentaire
- Création du contenuConstruire un processus documentaire
- De la rédaction à la communication techniqueComprendre la documentation
- Définition du projetConstruire un processus documentaire
- Documentation technique : diminuer les coûts, améliorer la satisfaction clientComprendre la documentation
- Du document à la base documentaire modulaireChoisir un modèle de rédaction
- Format cibleChoisir un modèle de rédactionFormats source et cible
- Format sourceChoisir un modèle de rédactionFormats source et cible
- Format structuré DITA XMLChoisir un modèle de rédactionDITA
- Formats et outilsChoisir un modèle de rédactionFormats source et cible
- Formats structurés et non structurésChoisir un modèle de rédactionRédaction structurée
- Git : du fichier au contenuAdopter le docs-as-codeGit
- Intégrer la documentation aux processus de développementAdopter le docs-as-codeGitDocs-as-code
- KISS : garder la documentation technique simpleComprendre la documentation
- Les bases SQL comme référentiel documentaireAdopter le docs-as-codeConception du référentiel
- Les CMS : le workflow en prime, mais une fiabilité à testerAdopter le docs-as-codeConception du référentielGestion de versions
- Les répertoires réseau partagés - peu adaptés au travail de groupeAdopter le docs-as-codeConception du référentiel
- Les systèmes de gestion de versions - rustiques mais fiablesAdopter le docs-as-codeGit
- Les trois niveaux de la documentation techniqueComprendre la documentation
- LivraisonConstruire un processus documentaire
- Mener un projet de bout en boutConstruire un processus documentaire
- Quel référentiel pour le travail de groupe ?Adopter le docs-as-codeConception du référentiel
- Rédaction technique : un processus industrielConstruire un processus documentaire
- RéférentielAdopter le docs-as-codeConception du référentiel
- Tester les produits pour les documenterConstruire un processus documentaire
- TraductionConstruire un processus documentaire
- Types d’informationComprendre la documentation
- Un référentiel unique ?Adopter le docs-as-codeConception du référentiel
- Une architecture documentaire trop complexe ?Choisir un modèle de rédactionDITA
- Utiliser les branches des systèmes de gestion de sourcesAdopter le docs-as-code
- Validation et contrôle qualitéConstruire un processus documentaire
TâcheGuides pas-à-pas et procédures concrètes orientés vers un résultat vérifiable.15 pages
- Automatisation et techniques spécialiséesAutomatisation et techniques spécialisées
- Créer des documents différents à partir des mêmes sources ReST (texte conditionnel)Automatisation et techniques spécialisées
- Créer des documents différents à partir des mêmes sources via JinjaAutomatisation et techniques spécialiséesJinja
- Créer des documents différents à partir des mêmes sources via Jinja (méthode objet)Automatisation et techniques spécialiséesJinja
- Didacticiels DITA XML et XSL-FOAutomatisation et techniques spécialisées
- Exemple : un pipeline CI/CD concret pour la documentationConstituer votre boîte à outilsExemples concrets
- Exemple : un workflow de revue documentaireConstituer votre boîte à outilsExemples concrets
- Exemple : un workflow docs-as-code basiqueConstituer votre boîte à outilsExemples concrets
- Exemple : une page Markdown bien structuréeConstituer votre boîte à outilsExemples concrets
- Expressions régulières en PythonAutomatisation et techniques spécialiséesPython
- Insérer automatiquement des données dans un fichier DITA XMLAutomatisation et techniques spécialiséesPython
- Insérer automatiquement des données dans un fichier reStructuredTextAutomatisation et techniques spécialiséesJinja
- Insérer automatiquement des données SQL dans un fichier reStructuredTextAutomatisation et techniques spécialiséesPython
- Le Raspberry Pi 3 en tant que plateforme de documentationAutomatisation et techniques spécialisées
- sed : modifiez votre texte sans ouvrir vos fichiersAutomatisation et techniques spécialisées
RéférenceFiches de consultation, syntaxe, spécifications, listes de paramètres et vérifications.18 pages
- Cas concret : documentation de NuFirewallChoisir un modèle de rédactionDITA
- Check-list : adoption du docs-as-codeConstituer votre boîte à outilsCheck-lists
- Check-list : audit documentaireConstituer votre boîte à outilsCheck-lists
- Check-list : migration documentaireConstituer votre boîte à outilsCheck-lists
- Check-list : préparation à la mise en productionConstituer votre boîte à outilsCheck-lists
- Check-list : qualité documentaireConstituer votre boîte à outilsCheck-lists
- Check-list : revue techniqueConstituer votre boîte à outilsCheck-lists
- Constituer votre boîte à outilsConstituer votre boîte à outils
- Exemple : une architecture de dépôt documentaireConstituer votre boîte à outilsExemples concrets
- Modèle : article conceptConstituer votre boîte à outilsModèles
- Modèle : article référenceConstituer votre boîte à outilsModèles
- Modèle : article tâcheConstituer votre boîte à outilsModèles
- Modèle : demande de revue documentaireConstituer votre boîte à outilsModèles
- Modèle : documentation d’APIConstituer votre boîte à outilsDocumentation d'API
- Modèle : plan de projet documentaireConstituer votre boîte à outilsModèles
Consultez les 21 thèmes transversaux du vocabulaire contrôlé de la documentation :
- Rédaction technique12 pagesC12
- DITA XML10 pagesC6T2R2
- Automatisation9 pagesT9
- Gestion de versions9 pagesC9
- Git8 pagesC7T1
- Markdown8 pagesC2T1R5
- Traduction8 pagesC4T1R3
- Docs-as-code7 pagesC3T2R2
- Python7 pagesT7
- Rédaction structurée7 pagesC7
- CI/CD6 pagesC3T2R1
- reStructuredText6 pagesT6
- Typage de l'information6 pagesC2T1R3
- Assurance qualité5 pagesC1T1R3
- Publication5 pagesC2T3
- Revue documentaire5 pagesC1T2R2
- Texte conditionnel5 pagesT4R1
- Réutilisation de contenu4 pagesC3R1
- Documentation d'API3 pagesC1R2
- Migration documentaire2 pagesC1R1
- Planification documentaire2 pagesC1R1
Principales versions
Versions de l’ensemble du site, étiquetées dans son dépôt Git.
Repositionnement en portfolio de rédaction technique
Repositionne le site comme portfolio de rédacteur technique senior d’Olivier Carrère, avec une page d’accueil orientée tâches et une page Expertise pensée pour les recruteurs.
S’appuie sur le système de design éditorial, l’audit de contenu EN/FR de 2026 et la nouvelle navigation en six sections.
Architecture de l’information et plateforme documentaire
Introduit une architecture de l’information fondée sur les objectifs du lecteur et restructure chaque article en page de concept, de tâche ou de référence, avec une boîte à outils pratique et un glossaire.
Ajoute une API documentaire statique (llms.txt, index JSON, schema.json, sélection de champs et pagination), l’assistant Interroger la documentation et l’Explorateur de documentation.
Migration vers Astro + Starlight
Remplace la chaîne Sphinx/reStructuredText par un site Astro + Starlight dont le contenu est rédigé en Markdown/MDX (fusion de la PR nº 2). Cette version pose les fondations du site actuel et succède à la série 1.x sous Sphinx.
À ce commit, les sources reStructuredText historiques figurent encore dans le dépôt ; le projet Astro a ensuite été déplacé à la racine du dépôt et la conversion du contenu achevée dans les commits suivants.
Comment cette documentation a évolué. Ces versions ne couvrent que la période récente : le corpus est passé auparavant d’un blog WordPress à un site Sphinx en reStructuredText, avant le portfolio Astro et Starlight actuel. Parcourir l’historique du site
Ce site est la pratique de la rédaction technique d'Olivier Carrère : un guide pratique pour concevoir, rédiger, maintenir et publier de la documentation technique, fondé sur ses méthodes, ses projets et son expérience. Le profil professionnel (en anglais) présente son parcours, ses travaux choisis et ses articles.
Que vous choisissiez entre DITA XML et Markdown, passiez à un workflow docs-as-code ou intégriez la documentation à votre chaîne CI/CD — ces guides couvrent les méthodes, formats et outils pour faire de la documentation une pratique d'ingénierie durable et évolutive.