# Expertise

## Travaux choisis

Projets documentaires qui démontrent les domaines d'expertise ci-dessous.

- [**Documentation de NuFirewall (DITA XML)**](https://docs.redaction-technique.org/fr/formats/nufirewall-case-study/): Documentation d'un produit logiciel citée par la presse comme un point fort du produit : stratégie de réutilisation par conref, texte conditionnel, sources prêtes pour la traduction. Démontre : DITA XML, Réutilisation de contenu, Texte conditionnel, Traduction.
- [**Ce portfolio, un projet docs-as-code**](https://docs.redaction-technique.org/fr/about-this-blog/#comment-ce-site-est-construit): Documentation bilingue FR/EN sous Git depuis 2014 : reStructuredText et DITA XML, aujourd'hui Astro et Starlight, compilée en CI à chaque modification. Démontre : Docs-as-code, Git, CI/CD, Astro et Starlight.
- [**Une API documentaire lisible par les machines**](https://docs.redaction-technique.org/fr/about-the-api/): Les mêmes sources Markdown servies aux scripts et agents IA (llms.txt, miroirs Markdown, index JSON), générées à la compilation. Démontre : Documentation développeur, llms.txt, JSON, Automatisation.
- [**DITA XML sur des projets multilingues**](https://docs.redaction-technique.org/fr/formats/dita-xml-case-studies/): Solutions et astuces issues de l'usage quotidien de DITA XML sur des projets de documentation technique multilingues. Démontre : DITA XML, Documentation multilingue.

## Docs-as-code

Intégrer la documentation aux workflows d'ingénierie, avec les mêmes outils et le même cycle de vie que le produit.

**Technologies et méthodes clés :** Git, Branches, Revue par pull request, Référentiels partagés, Markdown et MDX

**Documentation sélectionnée :**

- [Intégrer la documentation aux processus de développement](https://docs.redaction-technique.org/fr/tech-writing-process/integrating-documentation-into-development/)
- [Les systèmes de gestion de versions - rustiques mais fiables](https://docs.redaction-technique.org/fr/tech-writing-process/version-control-systems/)
- [Git : du fichier au contenu](https://docs.redaction-technique.org/fr/tech-writing-process/git-from-file-to-content/)
- [Utiliser les branches des systèmes de gestion de sources](https://docs.redaction-technique.org/fr/tech-writing-process/using-branches/)
- [Un référentiel unique ?](https://docs.redaction-technique.org/fr/tech-writing-process/single-repository/)
- [Référentiel](https://docs.redaction-technique.org/fr/tech-writing-process/repository/)
- [Quel référentiel pour le travail de groupe ?](https://docs.redaction-technique.org/fr/tech-writing-process/which-repository-for-group-work/)
- [Exemple : un workflow docs-as-code basique](https://docs.redaction-technique.org/fr/toolkit/example-docs-as-code-workflow/)
- [Exemple : un workflow de revue documentaire](https://docs.redaction-technique.org/fr/toolkit/example-review-workflow/)
- [Check-list : adoption du docs-as-code](https://docs.redaction-technique.org/fr/toolkit/docs-as-code-adoption-checklist/)

<span id="rédaction-structurée-et-dita"></span>

## DITA et rédaction structurée

Déterminer le degré de structure dont le contenu a besoin, puis construire des sources modulaires et réutilisables en DITA XML.

**Technologies et méthodes clés :** DITA XML, Typage des topics, Conrefs, Ditamaps, Texte conditionnel, DITA-OT, XSLT, XSL-FO, DocBook

**Documentation sélectionnée :**

- [Cas concret : documentation de NuFirewall](https://docs.redaction-technique.org/fr/formats/nufirewall-case-study/) : stratégie de réutilisation et de traduction sur un produit logiciel.
- [Cas concrets d’utilisation de DITA XML](https://docs.redaction-technique.org/fr/formats/dita-xml-case-studies/)
- [Formats structurés et non structurés](https://docs.redaction-technique.org/fr/formats/structured-vs-unstructured-formats/)
- [Format structuré DITA XML](https://docs.redaction-technique.org/fr/formats/)
- [Une architecture documentaire trop complexe ?](https://docs.redaction-technique.org/fr/formats/document-architecture-complexity/)
- [Formats et outils](https://docs.redaction-technique.org/fr/costs/formats-and-tools/)
- [Format source](https://docs.redaction-technique.org/fr/tech-writing-process/source-format/)
- [Didacticiels DITA XML et XSL-FO](https://docs.redaction-technique.org/fr/tutorials/dita-xml-xsl-fo-tutorials/)

<span id="architecture-documentaire-et-de-linformation"></span>

## Architecture documentaire

Structurer des ensembles documentaires pour qu'ils passent à l'échelle et restent cohérents en grandissant.

**Technologies et méthodes clés :** Typologie de l'information, Concept / tâche / référence, Contenu modulaire, Organisation du dépôt, Modèles d'articles

**Documentation sélectionnée :**

- [Typologie de l'information](https://docs.redaction-technique.org/fr/toolkit/information-types/)
- [Du document à la base documentaire modulaire](https://docs.redaction-technique.org/fr/formats/modular-documentation/)
- [Les trois niveaux de la documentation technique](https://docs.redaction-technique.org/fr/costs/three-levels-of-documentation/)
- [Exemple : une architecture de dépôt documentaire](https://docs.redaction-technique.org/fr/toolkit/example-repository-structure/)
- Modèles d'articles : [concept](https://docs.redaction-technique.org/fr/toolkit/concept-article-template/), [tâche](https://docs.redaction-technique.org/fr/toolkit/task-article-template/) et [référence](https://docs.redaction-technique.org/fr/toolkit/reference-article-template/)
- [Exemple : une page Markdown bien structurée](https://docs.redaction-technique.org/fr/toolkit/example-markdown-page/)
- [Glossaire](https://docs.redaction-technique.org/fr/reference/glossary/)

## Documentation développeur et d'API

La documentation destinée à ceux qui construisent sur un produit, maintenue exacte par les tests produit et les revues techniques.

**Technologies et méthodes clés :** Référence d'API, llms.txt, Miroirs Markdown, Index JSON, Revue technique

**Documentation sélectionnée :**

- [Modèle : documentation d'API](https://docs.redaction-technique.org/fr/toolkit/api-documentation-template/)
- [À propos de l'API de ce manuel](https://docs.redaction-technique.org/fr/about-the-api/) : une API documentaire statique et opérationnelle pour les scripts et agents IA.
- [Tester les produits pour les documenter](https://docs.redaction-technique.org/fr/tech-writing-process/testing-products/)
- [Collecte de l’information](https://docs.redaction-technique.org/fr/tech-writing-process/gathering-information/) : travailler avec les ingénieurs et autres experts métier.
- [Check-list : revue technique](https://docs.redaction-technique.org/fr/toolkit/technical-review-checklist/)
- [Modèle : demande de revue documentaire](https://docs.redaction-technique.org/fr/toolkit/documentation-review-request-template/)

<span id="automatisation-documentaire-et-cicd"></span>

## Automatisation et CI/CD

Compiler, vérifier et publier la documentation automatiquement, et générer le contenu à partir des données plutôt que de le recopier à la main.

**Technologies et méthodes clés :** Pipelines CI/CD, Publication multiformat, Python, Jinja, SQLite, Bash, sed, Expressions rationnelles, reStructuredText et Sphinx

**Documentation sélectionnée :**

- [Exemple : un pipeline CI/CD concret pour la documentation](https://docs.redaction-technique.org/fr/toolkit/example-cicd-pipeline/)
- [Insérer automatiquement des données dans un fichier DITA XML](https://docs.redaction-technique.org/fr/tutorials/auto-insert-data-dita-xml/)
- [Insérer automatiquement des données SQL dans un fichier reStructuredText](https://docs.redaction-technique.org/fr/tutorials/auto-insert-sql-data-restructuredtext/)
- [Insérer automatiquement des données dans un fichier reStructuredText](https://docs.redaction-technique.org/fr/tutorials/auto-insert-data-restructuredtext/)
- [Créer des documents différents à partir des mêmes sources via Jinja](https://docs.redaction-technique.org/fr/tutorials/conditional-text-jinja/) et [par la méthode objet](https://docs.redaction-technique.org/fr/tutorials/conditional-text-jinja-object-method/)
- [Créer des documents différents à partir des mêmes sources ReST (texte conditionnel)](https://docs.redaction-technique.org/fr/tutorials/conditional-text-sphinx-rest/)
- [Expressions régulières en Python](https://docs.redaction-technique.org/fr/tutorials/python-regular-expressions/)
- [sed : modifiez votre texte sans ouvrir vos fichiers](https://docs.redaction-technique.org/fr/tutorials/sed-text-editing/)
- [Le Raspberry Pi 3 en tant que plateforme de documentation](https://docs.redaction-technique.org/fr/tutorials/raspberry-pi-documentation-platform/)
- [Mener un projet de bout en bout](https://docs.redaction-technique.org/fr/tutorials/project-end-to-end/)
- [Format cible](https://docs.redaction-technique.org/fr/tech-writing-process/target-format/) : publication multiformat (PDF, HTML, EPUB) à partir d'une source unique.

## Documentation assistée par l'IA

Utiliser l'IA dans une composante du workflow documentaire, toujours avec une relecture humaine : traduction, assistant documentaire fondé sur les pages de ce portfolio et API documentaire lisible par les scripts et les agents IA.

**Technologies et méthodes clés :** DeepL, GPT-4o, Claude, llms.txt, Relecture humaine

**Documentation sélectionnée :**

- [Interroger la documentation](https://docs.redaction-technique.org/fr/ask/) : un assistant qui répond uniquement à partir des pages de ce portfolio, et cite les pages utilisées.
- [L'API documentaire](https://docs.redaction-technique.org/fr/about-the-api/) : llms.txt, miroirs Markdown et index JSON générés à la compilation pour les scripts et les agents IA.
- [Translating legacy French docs to English with DeepL and GPT-4o](https://redaction-technique.org/ai-translation-legacy-technical-docs) (en anglais) : le workflow utilisé pour traduire ce portfolio, avec les diffs Git comme filet de sécurité.
- [Reliability vs. latency: running Claude through the CLI](https://redaction-technique.org/reliability-vs-latency-claude-cli) (en anglais) : boucler la boucle de rétroaction pour que le modèle corrige ses propres erreurs de compilation.
- [Persona prompting: check this before printing](https://redaction-technique.org/persona-prompting-typographer) (en anglais) : une revue technique structurée obtenue par un prompt ciblé.

## Processus documentaire et qualité

Mener la documentation comme un processus explicite et reproductible, de la définition du projet à la livraison, avec des contrôles qualité à chaque étape.

**Technologies et méthodes clés :** Planification de projet, Contrôles qualité, Check-lists, Préparation à la mise en production, Audits documentaires

**Documentation sélectionnée :**

- [Rédaction technique : un processus industriel](https://docs.redaction-technique.org/fr/tech-writing-process/)
- [Définition du projet](https://docs.redaction-technique.org/fr/tech-writing-process/project-definition/) et le [modèle de plan de projet](https://docs.redaction-technique.org/fr/toolkit/documentation-project-plan-template/)
- [Création du contenu](https://docs.redaction-technique.org/fr/tech-writing-process/content-creation/)
- [Validation et contrôle qualité](https://docs.redaction-technique.org/fr/tech-writing-process/validation-quality-control/)
- [Livraison](https://docs.redaction-technique.org/fr/tech-writing-process/delivery/)
- Check-lists : [qualité documentaire](https://docs.redaction-technique.org/fr/toolkit/documentation-quality-checklist/), [préparation à la mise en production](https://docs.redaction-technique.org/fr/toolkit/release-readiness-checklist/), [audit documentaire](https://docs.redaction-technique.org/fr/toolkit/documentation-audit-checklist/) et [migration documentaire](https://docs.redaction-technique.org/fr/toolkit/documentation-migration-checklist/)
- [Documentation technique : diminuer les coûts, améliorer la satisfaction client](https://docs.redaction-technique.org/fr/costs/)
- [De la rédaction à la communication technique](https://docs.redaction-technique.org/fr/costs/copywriting-to-technical-communication/)
- [Principe de simplicité KISS](https://docs.redaction-technique.org/fr/costs/kiss-principle/)

## Documentation multilingue

Planifier la traduction dès le début du projet, et structurer les sources pour que la traduction reste abordable. Je suis diplômé d'une école de traduction et j'ai plusieurs années d'expérience en traduction technique.

**Technologies et méthodes clés :** Planification de la traduction, Branches linguistiques, DITA XML fondé sur les conrefs, FR/EN

**Documentation sélectionnée :**

- [Traduction](https://docs.redaction-technique.org/fr/tech-writing-process/translation/)
- [Utiliser les branches des systèmes de gestion de sources](https://docs.redaction-technique.org/fr/tech-writing-process/using-branches/) : branches linguistiques parallèles.
- [Cas concret : documentation de NuFirewall](https://docs.redaction-technique.org/fr/formats/nufirewall-case-study/) : traduire du contenu DITA XML fondé sur les conrefs.

## Outils et formats

Outils et formats abordés dans ces articles, ou utilisés pour construire ce site :

Git, GitHub Actions, Markdown et MDX, Astro et Starlight, reStructuredText et Sphinx, DITA XML, DocBook, XSLT, XSL-FO, LaTeX, Python, Jinja, SQLite, Bash, sed, awk, expressions rationnelles, Makefile

## Me contacter

Pour échanger sur un poste ou un projet de rédaction technique, contactez-moi sur [LinkedIn](https://www.linkedin.com/in/carrereolivier/). Plus d'informations dans mon [profil professionnel](https://redaction-technique.org/) ↗ (en anglais) et sur la page [À propos](https://docs.redaction-technique.org/fr/about-this-blog/).

---

Source: https://docs.redaction-technique.org/fr/expertise/