Aller au contenu
Olivier CarrèrePratique de la rédaction technique

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

Explorer par domaineTravaux choisisProfil professionnel (en anglais) ↗

Disponible pour une nouvelle opportunité à partir d’octobre 2026

Voir en Markdown
Apprendre

Suivre le parcours méthodique en 6 étapes pour maîtriser la documentation de bout en bout.

Trouver

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.

  1. Comprendre la documentation

    Pourquoi l’architecture documentaire compte : valeur, maturité, types d’information.

  2. Construire un processus documentaire

    Le processus étape par étape, de la définition du projet à la livraison.

  3. Adopter le docs-as-code

    Git, conception du référentiel, branches, CI/CD et contrôles automatisés.

  4. Choisir un modèle de rédaction

    Rédaction structurée, DITA, Markdown, réutilisation du contenu et formats.

  5. Constituer votre boîte à outils

    Modèles, check-lists et exemples concrets à réutiliser.

  6. 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

Tous les travaux choisis, avec l’expertise que chaque projet démontre, sont sur la page Expertise. Pour échanger sur un poste ou un projet de rédaction technique, contactez-moi sur LinkedIn ou consultez mon profil professionnel ↗ (en anglais).

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.

Explorer tout l’historique

Diagramme simplifié de l’historique Git du site, du commit à la section puis à la page : 4 commits rejoignent 3 sections (2. Construire un processus documentaire, 4. Choisir un modèle de rédaction, 6. 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.

  • Docs-as-code

    La documentation sous Git à côté du produit : branches, revue par pull request et conception du référentiel.

  • DITA et rédaction structurée

    DITA XML orienté topics, réutilisation du contenu par conref et texte conditionnel, avec une étude de cas produit.

  • Architecture documentaire

    Typologie de l’information, contenu modulaire, structure du dépôt et modèles d’articles cohérents.

  • Documentation développeur et d'API

    Modèles de référence d’API, une API documentaire lisible par les machines et la revue technique avec les ingénieurs.

  • Automatisation et CI/CD

    Pipelines de compilation, de vérification et de publication, et contenu généré à partir des données avec Python et Jinja.

  • Documentation assistée par l'IA

    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.

Aussi : Processus documentaire et qualité · Documentation multilingue

Partir de votre objectif

Que cherchez-vous à faire ?

  • Démarrer un projet documentaire

    ConceptPlanification documentaire

    Définir l’audience, le périmètre et les livrables avant d’écrire le moindre mot.

  • Construire un processus documentaire

    ConceptRédaction technique

    Voir toute la chaîne de production, de la collecte d’information à la livraison.

  • Adopter le docs-as-code

    ConceptDocs-as-code

    Gérer la documentation comme du code : gestion de versions, revue et CI/CD.

  • Choisir un modèle de rédaction

    Vue d’ensembleRédaction structurée

    Déterminer le degré de structure dont votre contenu a besoin, du Markdown à DITA.

  • Améliorer un système documentaire existant

    RéférenceAssurance qualité

    Auditer l’existant : pages orphelines, doublons et contenus obsolètes.

  • Automatiser la documentation

    TâcheCI/CD

    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.

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.

L’assistant répond uniquement à partir de la documentation disponible sur ce site. Il ne fait pas appel à des connaissances générales.

Exemples :

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.

1. Comprendre la documentation6 pages
2. Construire un processus documentaire10 pages
3. Adopter le docs-as-code11 pages
4. Choisir un modèle de rédaction11 pages
5. Constituer votre boîte à outils18 pages
6. Automatisation et techniques spécialisées11 pages
Explorer la référence3 pages
API documentaire et IA2 pages

Principales versions

Versions de l’ensemble du site, étiquetées dans son dépôt Git.

  1. v2.2.0 : code source étiqueté sur GitHub

    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.

  2. v2.1.0 : code source étiqueté sur GitHub

    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.

  3. v2.0.0 : code source étiqueté sur GitHub

    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

Pratique de la rédaction technique

Profil professionnel ↗

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.