{ "version": "1.0", "site": "https://docs.redaction-technique.org", "locale": "fr", "count": 74, "filters": { "contentType": [ "concept", "task", "reference" ], "pageType": [ "topic", "index", "landing", "overview", "utility" ] }, "taxonomy": { "contentType": { "description": "Primary information type and reader intent of substantive documentation.", "values": [ "concept", "task", "reference" ], "items": { "concept": { "label": "Concept", "description": "Explains ideas, architecture, principles, background, and relationships to build mental models." }, "task": { "label": "Task", "description": "Provides sequential, step-by-step procedures to accomplish a specific goal with a verifiable outcome." }, "reference": { "label": "Reference", "description": "Provides structured lookup facts, specifications, syntax, configuration options, parameters, and constraints." } } }, "pageType": { "description": "Structural role of the page within the documentation site.", "values": [ "topic", "index", "landing", "overview", "utility" ], "items": { "topic": { "label": "Topic", "description": "A modular documentation article structured around a primary information type (concept, task, or reference)." }, "index": { "label": "Index", "description": "A navigational directory page organizing and listing documentation topics within a section." }, "landing": { "label": "Landing page", "description": "A curated entry point introducing a documentation area or guiding readers by intent." }, "overview": { "label": "Overview", "description": "A high-level orientation or architectural summary introducing a section." }, "utility": { "label": "Utility", "description": "A supporting functional page such as an interactive assistant or site information page." } } } }, "documents": [ { "title": "Rédaction technique, étape par étape - Olivier Carrère", "description": "Guides experts en rédaction technique, DITA XML, Markdown, docs-as-code et automatisation de contenu pour les communicants techniques et équipes documentation.", "url": "https://docs.redaction-technique.org/fr/", "markdown": "https://docs.redaction-technique.org/fr.md", "locale": "fr", "pageType": "landing", "contentType": null, "wordCount": 182, "headings": [ { "level": 2, "text": "Apprendre la rédaction technique", "slug": "apprendre-la-rdaction-technique" }, { "level": 2, "text": "Construire un processus documentaire", "slug": "construire-un-processus-documentaire" }, { "level": 2, "text": "Adopter le docs-as-code", "slug": "adopter-le-docs-as-code" }, { "level": 2, "text": "Utiliser la rédaction structurée", "slug": "utiliser-la-rdaction-structure" }, { "level": 2, "text": "Choisir outils et formats", "slug": "choisir-outils-et-formats" } ], "keywords": [], "tags": [] }, { "title": "À propos de ce blog", "description": "Blog de rédaction technique spécialisé en DITA XML, docs-as-code, automatisation de la documentation et communication technique, par Olivier Carrère, rédacteur technique.", "url": "https://docs.redaction-technique.org/fr/about-this-blog/", "markdown": "https://docs.redaction-technique.org/fr/about-this-blog.md", "locale": "fr", "pageType": "utility", "contentType": null, "wordCount": 676, "headings": [ { "level": 2, "text": "Libérez vos informations de leurs silos", "slug": "librez-vos-informations-de-leurs-silos" }, { "level": 3, "text": "Intégrer la documentation aux processus de développement", "slug": "intgrer-la-documentation-aux-processus-de-dveloppement" }, { "level": 3, "text": "Les sources de ce blog sont gérées sous Git", "slug": "les-sources-de-ce-blog-sont-gres-sous-git" }, { "level": 3, "text": "Formats sources", "slug": "formats-sources" }, { "level": 3, "text": "Formats cibles", "slug": "formats-cibles" } ], "keywords": [], "tags": [] }, { "title": "Définition du projet", "description": "Définissez votre projet de documentation technique avant d'écrire : identifiez le public cible, le périmètre, les livrables et les critères de succès du processus.", "url": "https://docs.redaction-technique.org/fr/tech-writing-process/project-definition/", "markdown": "https://docs.redaction-technique.org/fr/tech-writing-process/project-definition.md", "locale": "fr", "pageType": "topic", "contentType": "concept", "wordCount": 303, "headings": [ { "level": 2, "text": "Définition", "slug": "dfinition" }, { "level": 2, "text": "Pourquoi c'est important", "slug": "pourquoi-cest-important" }, { "level": 2, "text": "Principes clés", "slug": "principes-cls" } ], "keywords": [], "tags": [] }, { "title": "Collecte de l’information", "description": "Collecte d'information en rédaction technique : interviews d'experts, tests produit, documentation existante et observations terrain pour construire un contenu précis.", "url": "https://docs.redaction-technique.org/fr/tech-writing-process/gathering-information/", "markdown": "https://docs.redaction-technique.org/fr/tech-writing-process/gathering-information.md", "locale": "fr", "pageType": "topic", "contentType": "concept", "wordCount": 213, "headings": [ { "level": 2, "text": "Définition", "slug": "dfinition" }, { "level": 2, "text": "Pourquoi c'est important", "slug": "pourquoi-cest-important" }, { "level": 2, "text": "Principes clés", "slug": "principes-cls" } ], "keywords": [], "tags": [] }, { "title": "Tester les produits pour les documenter", "description": "Le rédacteur technique doit tester le produit dans des conditions proches de celles de l'utilisateur avant de le documenter, plutôt que de compiler les avis partiels des acteurs de l'entreprise - source d'erreurs et de déperdition d'information.", "url": "https://docs.redaction-technique.org/fr/tech-writing-process/testing-products/", "markdown": "https://docs.redaction-technique.org/fr/tech-writing-process/testing-products.md", "locale": "fr", "pageType": "topic", "contentType": "concept", "wordCount": 658, "headings": [ { "level": 2, "text": "Définition", "slug": "dfinition" }, { "level": 2, "text": "Pourquoi c'est important", "slug": "pourquoi-cest-important" }, { "level": 2, "text": "Principes clés", "slug": "principes-cls" }, { "level": 2, "text": "Compromis", "slug": "compromis" } ], "keywords": [], "tags": [] }, { "title": "Format source", "description": "Les traitements de texte nous ont déshabitués à distinguer le fond de la forme. Mais confondre les deux entraîne beaucoup d'erreurs et de perte de temps.", "url": "https://docs.redaction-technique.org/fr/tech-writing-process/source-format/", "markdown": "https://docs.redaction-technique.org/fr/tech-writing-process/source-format.md", "locale": "fr", "pageType": "topic", "contentType": "concept", "wordCount": 1637, "headings": [ { "level": 2, "text": "Définition", "slug": "dfinition" }, { "level": 2, "text": "Pourquoi c'est important", "slug": "pourquoi-cest-important" }, { "level": 2, "text": "Principes clés", "slug": "principes-cls" }, { "level": 2, "text": "Documents monolithiques ou modulaires", "slug": "documents-monolithiques-ou-modulaires" }, { "level": 3, "text": "Le Markdown comme format source", "slug": "le-markdown-comme-format-source" }, { "level": 3, "text": "Qu’est-ce qu’un module d’information ?", "slug": "quest-ce-quun-module-dinformation" }, { "level": 2, "text": "Fichiers binaires ou texte", "slug": "fichiers-binaires-ou-texte" } ], "keywords": [], "tags": [] }, { "title": "Format cible", "description": "Le format cible est celui que les utilisateurs consomment - PDF, HTML ou aide compilée - généré à partir d'une source unique. Découvrez la différence entre publication totalement automatique, semi-automatique et manuelle.", "url": "https://docs.redaction-technique.org/fr/tech-writing-process/target-format/", "markdown": "https://docs.redaction-technique.org/fr/tech-writing-process/target-format.md", "locale": "fr", "pageType": "topic", "contentType": "concept", "wordCount": 237, "headings": [ { "level": 2, "text": "Définition", "slug": "dfinition" }, { "level": 2, "text": "Exemples", "slug": "exemples" } ], "keywords": [], "tags": [] }, { "title": "Création du contenu", "description": "Le rédacteur technique crée le contenu du projet de rédaction technique dans un dialogue constant avec les différents acteurs de la société : services R&D, marketing.", "url": "https://docs.redaction-technique.org/fr/tech-writing-process/content-creation/", "markdown": "https://docs.redaction-technique.org/fr/tech-writing-process/content-creation.md", "locale": "fr", "pageType": "topic", "contentType": "concept", "wordCount": 121, "headings": [ { "level": 2, "text": "Définition", "slug": "dfinition" }, { "level": 2, "text": "Principes clés", "slug": "principes-cls" } ], "keywords": [], "tags": [] }, { "title": "Intégrer la documentation aux processus de développement", "description": "Découvrez pourquoi la documentation technique doit être livrée, versionnée et contrôlée en même temps que le produit, grâce aux formats texte comme DocBook, DITA XML et reStructuredText.", "url": "https://docs.redaction-technique.org/fr/tech-writing-process/integrating-documentation-into-development/", "markdown": "https://docs.redaction-technique.org/fr/tech-writing-process/integrating-documentation-into-development.md", "locale": "fr", "pageType": "topic", "contentType": "concept", "wordCount": 240, "headings": [ { "level": 2, "text": "Définition", "slug": "dfinition" }, { "level": 2, "text": "Principes clés", "slug": "principes-cls" }, { "level": 2, "text": "Pourquoi c'est important", "slug": "pourquoi-cest-important" } ], "keywords": [], "tags": [] }, { "title": "Les systèmes de gestion de versions - rustiques mais fiables", "description": "Gérez la documentation technique avec Git ou Subversion comme du code source : suivez les modifications, collaborez en équipe et restaurez des versions.", "url": "https://docs.redaction-technique.org/fr/tech-writing-process/version-control-systems/", "markdown": "https://docs.redaction-technique.org/fr/tech-writing-process/version-control-systems.md", "locale": "fr", "pageType": "topic", "contentType": "concept", "wordCount": 488, "headings": [ { "level": 2, "text": "Définition", "slug": "dfinition" }, { "level": 2, "text": "Principes clés", "slug": "principes-cls" }, { "level": 2, "text": "Compromis", "slug": "compromis" } ], "keywords": [], "tags": [] }, { "title": "Git : du fichier au contenu", "description": "Pensez contenu plutôt que fichiers avec Git : branches, commits et diffs pour la documentation technique simplifient la collaboration et la gestion des versions.", "url": "https://docs.redaction-technique.org/fr/tech-writing-process/git-from-file-to-content/", "markdown": "https://docs.redaction-technique.org/fr/tech-writing-process/git-from-file-to-content.md", "locale": "fr", "pageType": "topic", "contentType": "concept", "wordCount": 1415, "headings": [ { "level": 2, "text": "Définition", "slug": "dfinition" }, { "level": 2, "text": "Principes clés", "slug": "principes-cls" }, { "level": 2, "text": "Faire sauter les goulets d’étranglement avec les branches", "slug": "faire-sauter-les-goulets-dtranglement-avec-les-branches" }, { "level": 2, "text": "Organiser son historique avec Git rebase", "slug": "organiser-son-historique-avec-git-rebase" } ], "keywords": [], "tags": [] }, { "title": "Utiliser les branches des systèmes de gestion de sources", "description": "Utilisez les branches Git pour gérer des projets documentaires parallèles, des variantes produit et des workflows de traduction sans conflits - guide pratique rédacteur.", "url": "https://docs.redaction-technique.org/fr/tech-writing-process/using-branches/", "markdown": "https://docs.redaction-technique.org/fr/tech-writing-process/using-branches.md", "locale": "fr", "pageType": "topic", "contentType": "concept", "wordCount": 371, "headings": [ { "level": 2, "text": "Définition", "slug": "dfinition" }, { "level": 2, "text": "Principes clés", "slug": "principes-cls" }, { "level": 2, "text": "Exemples", "slug": "exemples" } ], "keywords": [], "tags": [] }, { "title": "Référentiel", "description": "Le contenu technique est un capital immatériel précieux. Découvrez comment choisir et gérer un référentiel documentaire pour le versionner, le protéger et le partager.", "url": "https://docs.redaction-technique.org/fr/tech-writing-process/repository/", "markdown": "https://docs.redaction-technique.org/fr/tech-writing-process/repository.md", "locale": "fr", "pageType": "topic", "contentType": "concept", "wordCount": 40, "headings": [ { "level": 2, "text": "Définition", "slug": "dfinition" } ], "keywords": [], "tags": [] }, { "title": "Un référentiel unique ?", "description": "Un référentiel Git unique pour la documentation technique maximise la réutilisation, la cohérence et la qualité, tout en simplifiant la collaboration en équipe.", "url": "https://docs.redaction-technique.org/fr/tech-writing-process/single-repository/", "markdown": "https://docs.redaction-technique.org/fr/tech-writing-process/single-repository.md", "locale": "fr", "pageType": "topic", "contentType": "concept", "wordCount": 189, "headings": [ { "level": 2, "text": "Définition", "slug": "dfinition" }, { "level": 2, "text": "Compromis", "slug": "compromis" } ], "keywords": [], "tags": [] }, { "title": "Quel référentiel pour le travail de groupe ?", "description": "Pourquoi les dossiers et disques réseau partagés montrent leurs limites en travail de groupe : les modifications concurrentes s'écrasent, le verrouillage des fichiers bloque les changements par lot et impose une coordination de tous les instants.", "url": "https://docs.redaction-technique.org/fr/tech-writing-process/which-repository-for-group-work/", "markdown": "https://docs.redaction-technique.org/fr/tech-writing-process/which-repository-for-group-work.md", "locale": "fr", "pageType": "topic", "contentType": "concept", "wordCount": 421, "headings": [ { "level": 2, "text": "Définition", "slug": "dfinition" }, { "level": 2, "text": "Pourquoi c'est important", "slug": "pourquoi-cest-important" }, { "level": 2, "text": "Compromis", "slug": "compromis" } ], "keywords": [], "tags": [] }, { "title": "Les répertoires réseau partagés - peu adaptés au travail de groupe", "description": "Les répertoires réseau partagés sont une solution inadaptée pour la documentation d'équipe. Pourquoi ils posent problème et quelles alternatives choisir pour collaborer.", "url": "https://docs.redaction-technique.org/fr/tech-writing-process/shared-network-directories/", "markdown": "https://docs.redaction-technique.org/fr/tech-writing-process/shared-network-directories.md", "locale": "fr", "pageType": "topic", "contentType": "concept", "wordCount": 373, "headings": [ { "level": 2, "text": "Définition", "slug": "dfinition" }, { "level": 2, "text": "Compromis", "slug": "compromis" } ], "keywords": [], "tags": [] }, { "title": "Base de données SQL", "description": "Dans un CMS comme Drupal, Joomla ou WordPress, le contenu documentaire est stocké en base SQL, qui ne conserve qu'un historique article par article et interdit la recherche-remplacement globale - d'où l'intérêt de le gérer en fichiers texte.", "url": "https://docs.redaction-technique.org/fr/tech-writing-process/sql-database/", "markdown": "https://docs.redaction-technique.org/fr/tech-writing-process/sql-database.md", "locale": "fr", "pageType": "topic", "contentType": "concept", "wordCount": 65, "headings": [ { "level": 2, "text": "Définition", "slug": "dfinition" }, { "level": 2, "text": "Compromis", "slug": "compromis" } ], "keywords": [], "tags": [] }, { "title": "Les CMS : le workflow en prime, mais une fiabilité à tester", "description": "Un CMS comme SharePoint ou Alfresco apporte workflow et verrouillage des fichiers à la rédaction technique, et certains (DocZone, Componize) gèrent même DITA XML - mais leur fiabilité pour archiver les sources reste à tester, adossée à une sauvegarde éprouvée.", "url": "https://docs.redaction-technique.org/fr/tech-writing-process/cms-workflow-and-reliability/", "markdown": "https://docs.redaction-technique.org/fr/tech-writing-process/cms-workflow-and-reliability.md", "locale": "fr", "pageType": "topic", "contentType": "concept", "wordCount": 280, "headings": [ { "level": 2, "text": "Définition", "slug": "dfinition" }, { "level": 2, "text": "Principes clés", "slug": "principes-cls" }, { "level": 2, "text": "Compromis", "slug": "compromis" }, { "level": 2, "text": "Articles connexes", "slug": "articles-connexes" } ], "keywords": [ "version-control" ], "tags": [ "version-control" ] }, { "title": "Validation et contrôle qualité", "description": "Validez la documentation technique avant livraison : menez la validation en parallèle de la rédaction, tracez chaque demande de modification via un workflow CMS ou un système de tickets, et comparez les versions pour fiabiliser les mises à jour.", "url": "https://docs.redaction-technique.org/fr/tech-writing-process/validation-quality-control/", "markdown": "https://docs.redaction-technique.org/fr/tech-writing-process/validation-quality-control.md", "locale": "fr", "pageType": "topic", "contentType": "concept", "wordCount": 561, "headings": [ { "level": 2, "text": "Définition", "slug": "dfinition" }, { "level": 2, "text": "Compromis", "slug": "compromis" }, { "level": 2, "text": "Workflow de création et validation", "slug": "workflow-de-cration-et-validation" } ], "keywords": [], "tags": [] }, { "title": "Traduction", "description": "Planifiez la traduction dès le début du projet documentaire : anticipez-la pour réduire coûts et délais, traduisez le contenu modulaire en parallèle de la rédaction, et organisez le référentiel source par langue.", "url": "https://docs.redaction-technique.org/fr/tech-writing-process/translation/", "markdown": "https://docs.redaction-technique.org/fr/tech-writing-process/translation.md", "locale": "fr", "pageType": "topic", "contentType": "concept", "wordCount": 377, "headings": [ { "level": 2, "text": "Définition", "slug": "dfinition" }, { "level": 2, "text": "Pourquoi c'est important", "slug": "pourquoi-cest-important" }, { "level": 2, "text": "Principes clés", "slug": "principes-cls" } ], "keywords": [], "tags": [] }, { "title": "Livraison", "description": "La livraison est l'étape finale : le contenu validé atteint ses cibles via le format et le canal définis au lancement du projet, de l'animation à la plaquette, en passant par les journaux clients, le site web et le guide imprimé ou PDF.", "url": "https://docs.redaction-technique.org/fr/tech-writing-process/delivery/", "markdown": "https://docs.redaction-technique.org/fr/tech-writing-process/delivery.md", "locale": "fr", "pageType": "topic", "contentType": "concept", "wordCount": 72, "headings": [ { "level": 2, "text": "Définition", "slug": "dfinition" }, { "level": 2, "text": "Exemples", "slug": "exemples" } ], "keywords": [], "tags": [] }, { "title": "Rédaction technique : un processus industriel", "description": "Découvrez le processus complet de rédaction technique : définition du projet, collecte d'information, création de contenu, validation, traduction et livraison.", "url": "https://docs.redaction-technique.org/fr/tech-writing-process/", "markdown": "https://docs.redaction-technique.org/fr/tech-writing-process.md", "locale": "fr", "pageType": "overview", "contentType": null, "wordCount": 258, "headings": [], "keywords": [], "tags": [] }, { "title": "Créer des documents différents à partir des mêmes sources ReST (texte conditionnel)", "description": "Générez plusieurs variantes de documents depuis les mêmes sources reStructuredText avec le texte conditionnel Sphinx - guide utilisateur, édition admin, édition lite.", "url": "https://docs.redaction-technique.org/fr/tutorials/conditional-text-sphinx-rest/", "markdown": "https://docs.redaction-technique.org/fr/tutorials/conditional-text-sphinx-rest.md", "locale": "fr", "pageType": "topic", "contentType": "task", "wordCount": 135, "headings": [ { "level": 2, "text": "Objectif", "slug": "objectif" } ], "keywords": [], "tags": [] }, { "title": "Créer des documents différents à partir des mêmes sources via Jinja", "description": "Profilez du contenu reStructuredText avec Jinja et Python en prétraitement pour générer des variantes de documents spécifiques au public depuis une source unique.", "url": "https://docs.redaction-technique.org/fr/tutorials/conditional-text-jinja/", "markdown": "https://docs.redaction-technique.org/fr/tutorials/conditional-text-jinja.md", "locale": "fr", "pageType": "topic", "contentType": "task", "wordCount": 43, "headings": [ { "level": 2, "text": "Objectif", "slug": "objectif" } ], "keywords": [], "tags": [] }, { "title": "Créer des documents différents à partir des mêmes sources via Jinja (méthode objet)", "description": "Profilez du contenu reStructuredText avec Jinja en définissant des objets (audience, plateforme, version) pour inclure ou exclure des blocs selon leurs attributs.", "url": "https://docs.redaction-technique.org/fr/tutorials/conditional-text-jinja-object-method/", "markdown": "https://docs.redaction-technique.org/fr/tutorials/conditional-text-jinja-object-method.md", "locale": "fr", "pageType": "topic", "contentType": "task", "wordCount": 930, "headings": [ { "level": 2, "text": "Objectif", "slug": "objectif" } ], "keywords": [], "tags": [] }, { "title": "Didacticiels", "description": "Guides pratiques pour automatiser, rédiger et publier la documentation technique avec Python, Jinja, reStructuredText et DITA XML.", "url": "https://docs.redaction-technique.org/fr/tutorials/", "markdown": "https://docs.redaction-technique.org/fr/tutorials.md", "locale": "fr", "pageType": "overview", "contentType": null, "wordCount": 86, "headings": [ { "level": 2, "text": "Rédaction structurée et publication multicanal", "slug": "rdaction-structure-et-publication-multicanal" }, { "level": 2, "text": "Automatisation de contenu et intégration de données", "slug": "automatisation-de-contenu-et-intgration-de-donnes" }, { "level": 2, "text": "Traitement de texte et outillage technique", "slug": "traitement-de-texte-et-outillage-technique" } ], "keywords": [], "tags": [] }, { "title": "Didacticiels DITA XML et XSL-FO", "description": "Tutoriels DITA XML et XSL-FO : créez une documentation topic par topic et appliquez des mises en page professionnelles pour la sortie PDF et l'impression.", "url": "https://docs.redaction-technique.org/fr/tutorials/dita-xml-xsl-fo-tutorials/", "markdown": "https://docs.redaction-technique.org/fr/tutorials/dita-xml-xsl-fo-tutorials.md", "locale": "fr", "pageType": "topic", "contentType": "task", "wordCount": 3118, "headings": [ { "level": 2, "text": "Aperçu", "slug": "aperu" }, { "level": 2, "text": "XSL-FO : filtrer du contenu selon des conditions « sauf » et « ou »", "slug": "xsl-fo-filtrer-du-contenu-selon-des-conditions-sauf-et-ou" }, { "level": 2, "text": "XSL-FO : insérer automatiquement un titre pour les exemples", "slug": "xsl-fo-insrer-automatiquement-un-titre-pour-les-exemples" }, { "level": 3, "text": "Insérer automatiquement une variable de texte avant le titre des exemples", "slug": "insrer-automatiquement-une-variable-de-texte-avant-le-titre-des-exemples" }, { "level": 2, "text": "Générer un PDF avec DITA Open Toolkit sous GNU/Linux", "slug": "gnrer-un-pdf-avec-dita-open-toolkit-sous-gnulinux" }, { "level": 2, "text": "Générer un PDF avec DITA Open Toolkit (Windows)", "slug": "gnrer-un-pdf-avec-dita-open-toolkit-windows" }, { "level": 2, "text": "Gérer les projets de documentation multilingues DITA XML", "slug": "grer-les-projets-de-documentation-multilingues-dita-xml" }, { "level": 3, "text": "Méthodologie de gestion des projets de documentation multilingues DITA XML", "slug": "mthodologie-de-gestion-des-projets-de-documentation-multilingues-dita-xml" }, { "level": 2, "text": "Créer des documents différents à partir des mêmes sources DITA XML", "slug": "crer-des-documents-diffrents-partir-des-mmes-sources-dita-abbr-titletexte-conditionnelxmlabbr" }, { "level": 2, "text": "DITA Open Toolkit : afficher les références croisées dans les PDF", "slug": "dita-open-toolkit-afficher-les-rfrences-croises-dans-les-pdf" }, { "level": 2, "text": "Afficher un index dans un PDF", "slug": "afficher-un-index-dans-un-pdf" }, { "level": 2, "text": "Utiliser l’IDE nXML pour DITA XML", "slug": "utiliser-lide-nxml-pour-dita-xml" }, { "level": 2, "text": "Accélérer sa saisie avec le mode Predictive pour Emacs", "slug": "acclrer-sa-saisie-avec-le-mode-predictive-pour-emacs" } ], "keywords": [], "tags": [] }, { "title": "Expressions régulières en Python", "description": "Utilisez la bibliothèque re de Python pour rechercher, extraire et transformer du texte dans vos fichiers de documentation - guide pratique avec patterns regex.", "url": "https://docs.redaction-technique.org/fr/tutorials/python-regular-expressions/", "markdown": "https://docs.redaction-technique.org/fr/tutorials/python-regular-expressions.md", "locale": "fr", "pageType": "topic", "contentType": "task", "wordCount": 53, "headings": [ { "level": 2, "text": "Objectif", "slug": "objectif" } ], "keywords": [], "tags": [] }, { "title": "Insérer automatiquement des données dans un fichier DITA XML", "description": "Automatisez la génération de fichiers DITA XML avec Python : insérez des données produit dynamiques dans vos topics DITA pour industrialiser la documentation technique.", "url": "https://docs.redaction-technique.org/fr/tutorials/auto-insert-data-dita-xml/", "markdown": "https://docs.redaction-technique.org/fr/tutorials/auto-insert-data-dita-xml.md", "locale": "fr", "pageType": "topic", "contentType": "task", "wordCount": 149, "headings": [ { "level": 2, "text": "Objectif", "slug": "objectif" } ], "keywords": [], "tags": [] }, { "title": "Insérer automatiquement des données dans un fichier reStructuredText", "description": "Insérez automatiquement des données produit dans vos fichiers reStructuredText avec Python pour générer des listes de versions par produit à partir de données structurées.", "url": "https://docs.redaction-technique.org/fr/tutorials/auto-insert-data-restructuredtext/", "markdown": "https://docs.redaction-technique.org/fr/tutorials/auto-insert-data-restructuredtext.md", "locale": "fr", "pageType": "topic", "contentType": "task", "wordCount": 214, "headings": [ { "level": 2, "text": "Objectif", "slug": "objectif" } ], "keywords": [], "tags": [] }, { "title": "Insérer automatiquement des données SQL dans un fichier reStructuredText", "description": "Nous allons créer une base de données de produits avec leurs versions, puis mettre en forme ces informations dans un fichier reStructuredText.", "url": "https://docs.redaction-technique.org/fr/tutorials/auto-insert-sql-data-restructuredtext/", "markdown": "https://docs.redaction-technique.org/fr/tutorials/auto-insert-sql-data-restructuredtext.md", "locale": "fr", "pageType": "topic", "contentType": "task", "wordCount": 327, "headings": [ { "level": 2, "text": "Objectif", "slug": "objectif" } ], "keywords": [], "tags": [] }, { "title": "Le Raspberry Pi 3 en tant que plateforme de documentation", "description": "Configurez une plateforme de documentation complète sur Raspberry Pi 3 : Sphinx, Git, et génération PDF, HTML et EPUB depuis des sources reStructuredText.", "url": "https://docs.redaction-technique.org/fr/tutorials/raspberry-pi-documentation-platform/", "markdown": "https://docs.redaction-technique.org/fr/tutorials/raspberry-pi-documentation-platform.md", "locale": "fr", "pageType": "topic", "contentType": "task", "wordCount": 1214, "headings": [ { "level": 2, "text": "Objectif", "slug": "objectif" }, { "level": 2, "text": "Configurez le Raspberry Pi 3", "slug": "configurez-le-raspberry-pi-3" }, { "level": 2, "text": "Installez les logiciels nécessaires à la gestion de ce blog", "slug": "installez-les-logiciels-ncessaires-la-gestion-de-ce-blog" }, { "level": 2, "text": "Récupérez les sources de ce blog", "slug": "rcuprez-les-sources-de-ce-blog" }, { "level": 2, "text": "Créez et modifiez le texte", "slug": "crez-et-modifiez-le-texte" }, { "level": 2, "text": "Créez et modifiez les schémas", "slug": "crez-et-modifiez-les-schmas" }, { "level": 2, "text": "Gérez les versions de votre documentation", "slug": "grez-les-versions-de-votre-documentation" }, { "level": 2, "text": "Générez votre documentation", "slug": "gnrez-votre-documentation" } ], "keywords": [], "tags": [] }, { "title": "Mener un projet de bout en bout", "description": "Il est assez rare, dans le cadre professionnel, de pouvoir mener un projet de (quasiment) A à Z, de la conception à la communication, en passant par la réalisation.", "url": "https://docs.redaction-technique.org/fr/tutorials/project-end-to-end/", "markdown": "https://docs.redaction-technique.org/fr/tutorials/project-end-to-end.md", "locale": "fr", "pageType": "topic", "contentType": "concept", "wordCount": 2537, "headings": [ { "level": 2, "text": "Aperçu", "slug": "aperu" }, { "level": 2, "text": "Gestion des photos d’une association", "slug": "gestion-des-photos-dune-association" }, { "level": 2, "text": "Récupération et tri des photos", "slug": "rcupration-et-tri-des-photos" }, { "level": 2, "text": "Galerie photo centralisée dans le cloud", "slug": "galerie-photo-centralise-dans-le-cloud" }, { "level": 2, "text": "Indexation des photos", "slug": "indexation-des-photos" }, { "level": 2, "text": "Sauvegarde incrémentale et décentralisée", "slug": "sauvegarde-incrmentale-et-dcentralise" }, { "level": 2, "text": "Définition d’un workflow de gestion des photos", "slug": "dfinition-dun-workflow-de-gestion-des-photos" }, { "level": 2, "text": "Définition des rôles des membres du workflow photo", "slug": "dfinition-des-rles-des-membres-du-workflow-photo" }, { "level": 2, "text": "Communication interne", "slug": "communication-interne" }, { "level": 2, "text": "Didacticiels vidéo", "slug": "didacticiels-vido" }, { "level": 2, "text": "Support papier", "slug": "support-papier" }, { "level": 2, "text": "LaTeX", "slug": "latex" }, { "level": 2, "text": "Suivi des modifications sous Git", "slug": "suivi-des-modifications-sous-git" }, { "level": 2, "text": "Style rédactionnel", "slug": "style-rdactionnel" }, { "level": 2, "text": "Iconographie", "slug": "iconographie" }, { "level": 2, "text": "Patience...", "slug": "patience" } ], "keywords": [], "tags": [] }, { "title": "sed : modifiez votre texte sans ouvrir vos fichiers", "description": "Utilisez sed, l'éditeur de flux Unix, pour modifier en lot vos fichiers de documentation technique sans les ouvrir - idéal pour automatiser les mises à jour de contenu.", "url": "https://docs.redaction-technique.org/fr/tutorials/sed-text-editing/", "markdown": "https://docs.redaction-technique.org/fr/tutorials/sed-text-editing.md", "locale": "fr", "pageType": "topic", "contentType": "task", "wordCount": 1075, "headings": [ { "level": 2, "text": "Objectif", "slug": "objectif" }, { "level": 2, "text": "Molière et GNU/Linux", "slug": "molire-et-gnulinux" }, { "level": 2, "text": "Beaucoup d’efforts...", "slug": "beaucoup-defforts" }, { "level": 2, "text": "Articles connexes", "slug": "articles-connexes" } ], "keywords": [], "tags": [] }, { "title": "Cas concret : documentation de NuFirewall", "description": "La documentation NuFirewall, saluée par la presse comme un atout produit, a été réalisée en DITA XML - étude de cas en authoring structuré pour logiciel informatique.", "url": "https://docs.redaction-technique.org/fr/formats/nufirewall-case-study/", "markdown": "https://docs.redaction-technique.org/fr/formats/nufirewall-case-study.md", "locale": "fr", "pageType": "topic", "contentType": "reference", "wordCount": 2522, "headings": [ { "level": 2, "text": "Aperçu", "slug": "aperu" }, { "level": 2, "text": "Partager des blocs d’information atomiques avec les conref", "slug": "partager-des-blocs-dinformation-atomiques-avec-les-conref" }, { "level": 3, "text": "Centraliser les conref dans un fichier unique", "slug": "centraliser-les-conref-dans-un-fichier-unique" }, { "level": 3, "text": "Utiliser le nœud XML de plus bas niveau", "slug": "utiliser-le-nud-xml-de-plus-bas-niveau" }, { "level": 3, "text": "Prendre en compte les contraintes de traduction", "slug": "prendre-en-compte-les-contraintes-de-traduction" }, { "level": 3, "text": "Imbriquer les conref", "slug": "imbriquer-les-conref" }, { "level": 3, "text": "Maximiser l’utilisation des conref pour faire baisser les coûts", "slug": "maximiser-lutilisation-des-conref-pour-faire-baisser-les-cots" }, { "level": 3, "text": "Protéger les informations confidentielles", "slug": "protger-les-informations-confidentielles" }, { "level": 2, "text": "Fournir une information ciblée avec le texte conditionnel ditaval", "slug": "fournir-une-information-cible-avec-le-texte-conditionnel-ditaval" } ], "keywords": [], "tags": [] }, { "title": "Cas concrets d’utilisation de DITA XML", "description": "Solutions et astuces DITA XML développées au quotidien sur des projets multilingues : réutilisation de topics, texte conditionnel, traduction et publication multicanal.", "url": "https://docs.redaction-technique.org/fr/formats/dita-xml-case-studies/", "markdown": "https://docs.redaction-technique.org/fr/formats/dita-xml-case-studies.md", "locale": "fr", "pageType": "topic", "contentType": "concept", "wordCount": 38, "headings": [], "keywords": [], "tags": [] }, { "title": "Du document à la base documentaire modulaire", "description": "DITA XML permet de passer du livre monolithique à la base documentaire modulaire pour réutiliser les topics, optimiser la traduction et publier en multicanal.", "url": "https://docs.redaction-technique.org/fr/formats/modular-documentation/", "markdown": "https://docs.redaction-technique.org/fr/formats/modular-documentation.md", "locale": "fr", "pageType": "topic", "contentType": "concept", "wordCount": 1939, "headings": [ { "level": 2, "text": "Définition", "slug": "dfinition" }, { "level": 2, "text": "Un langage à balises", "slug": "un-langage-balises" }, { "level": 2, "text": "Typologie de haut niveau de l’information", "slug": "typologie-de-haut-niveau-de-linformation" }, { "level": 2, "text": "Organisation à la demande du contenu", "slug": "organisation-la-demande-du-contenu" }, { "level": 2, "text": "Le single-sourcing : un format source, plusieurs formats cibles", "slug": "le-single-sourcing-un-format-source-plusieurs-formats-cibles" }, { "level": 2, "text": "Les topics, modules d’information de base DITA XML", "slug": "les-topics-modules-dinformation-de-base-dita-xml" }, { "level": 2, "text": "Gérer son contenu DITA XML avec ou sans CMS ?", "slug": "grer-son-contenu-dita-xml-avec-ou-sans-cms" } ], "keywords": [], "tags": [] }, { "title": "Format structuré DITA XML", "description": "Réduisez les coûts et délais en rédaction technique en choisissant le bon format d'authoring structuré et en optimisant la réutilisation du contenu documentaire.", "url": "https://docs.redaction-technique.org/fr/formats/", "markdown": "https://docs.redaction-technique.org/fr/formats.md", "locale": "fr", "pageType": "overview", "contentType": null, "wordCount": 389, "headings": [], "keywords": [], "tags": [] }, { "title": "Formats structurés et non structurés", "description": "Comparez les formats structurés (DITA XML, DocBook) et non structurés (Word, PDF) pour la documentation technique : réutilisation, traduction et évolutivité.", "url": "https://docs.redaction-technique.org/fr/formats/structured-vs-unstructured-formats/", "markdown": "https://docs.redaction-technique.org/fr/formats/structured-vs-unstructured-formats.md", "locale": "fr", "pageType": "topic", "contentType": "concept", "wordCount": 2222, "headings": [ { "level": 2, "text": "Définition", "slug": "dfinition" }, { "level": 2, "text": "Principes clés", "slug": "principes-cls" }, { "level": 2, "text": "DocBook ou DITA XML ?", "slug": "docbook-ou-dita-xml" }, { "level": 2, "text": "Migration de FrameMaker vers DITA XML", "slug": "migration-de-framemaker-vers-dita-xml" }, { "level": 3, "text": "Restructuration du contenu FrameMaker", "slug": "restructuration-du-contenu-framemaker" }, { "level": 3, "text": "Table de conversion FrameMaker vers DITA XML", "slug": "table-de-conversion-framemaker-vers-dita-xml" }, { "level": 3, "text": "Procédure de migration pas à pas", "slug": "procdure-de-migration-pas-pas" } ], "keywords": [], "tags": [] }, { "title": "Une architecture documentaire trop complexe ?", "description": "DITA XML permet des gains de productivité en réduisant le volume source que le rédacteur technique crée, traduit et maintient, au prix d'une plus grande complexité.", "url": "https://docs.redaction-technique.org/fr/formats/document-architecture-complexity/", "markdown": "https://docs.redaction-technique.org/fr/formats/document-architecture-complexity.md", "locale": "fr", "pageType": "topic", "contentType": "concept", "wordCount": 245, "headings": [ { "level": 2, "text": "Définition", "slug": "dfinition" }, { "level": 2, "text": "Compromis", "slug": "compromis" }, { "level": 2, "text": "Exemples", "slug": "exemples" } ], "keywords": [], "tags": [] }, { "title": "De la rédaction à la communication technique", "description": "La communication technique ne se réduit pas à la rédaction produit. Découvrez leur différence de périmètre et la valeur ajoutée de la communication technique.", "url": "https://docs.redaction-technique.org/fr/costs/copywriting-to-technical-communication/", "markdown": "https://docs.redaction-technique.org/fr/costs/copywriting-to-technical-communication.md", "locale": "fr", "pageType": "topic", "contentType": "concept", "wordCount": 422, "headings": [ { "level": 2, "text": "Définition", "slug": "dfinition" }, { "level": 2, "text": "Principes clés", "slug": "principes-cls" } ], "keywords": [], "tags": [] }, { "title": "Documentation technique : diminuer les coûts, améliorer la satisfaction client", "description": "Réduisez les coûts de documentation et améliorez la qualité grâce à la rédaction technique industrielle, au contenu modulaire DITA XML et à l'authoring structuré.", "url": "https://docs.redaction-technique.org/fr/costs/", "markdown": "https://docs.redaction-technique.org/fr/costs.md", "locale": "fr", "pageType": "overview", "contentType": null, "wordCount": 263, "headings": [ { "level": 2, "text": "Définition", "slug": "dfinition" }, { "level": 2, "text": "Principes clés", "slug": "principes-cls" } ], "keywords": [], "tags": [] }, { "title": "Formats et outils", "description": "Pour industrialiser la rédaction technique, le format importe plus que l’outil. Comparez les formats propriétaires comme Word et FrameMaker aux standards ouverts comme DITA XML et DocBook pour votre contexte.", "url": "https://docs.redaction-technique.org/fr/costs/formats-and-tools/", "markdown": "https://docs.redaction-technique.org/fr/costs/formats-and-tools.md", "locale": "fr", "pageType": "topic", "contentType": "concept", "wordCount": 269, "headings": [ { "level": 2, "text": "Définition", "slug": "dfinition" }, { "level": 2, "text": "Principes clés", "slug": "principes-cls" } ], "keywords": [], "tags": [] }, { "title": "Les trois niveaux de la documentation technique", "description": "Comparez les trois niveaux de maturité de la documentation technique - des notes informelles au contenu modulaire structuré - et découvrez ce qui distingue chaque niveau.", "url": "https://docs.redaction-technique.org/fr/costs/three-levels-of-documentation/", "markdown": "https://docs.redaction-technique.org/fr/costs/three-levels-of-documentation.md", "locale": "fr", "pageType": "topic", "contentType": "concept", "wordCount": 321, "headings": [ { "level": 2, "text": "Définition", "slug": "dfinition" }, { "level": 2, "text": "Niveau 1 : la friche", "slug": "niveau-1-la-friche" }, { "level": 2, "text": "Niveau 2 : le jardin à l’anglaise - documentation par sujets", "slug": "niveau-2-le-jardin-langlaise---documentation-par-sujets" }, { "level": 2, "text": "Niveau 3 : le jardin à la française - DITA XML structuré", "slug": "niveau-3-le-jardin-la-franaise---dita-xml-structur" } ], "keywords": [], "tags": [] }, { "title": "Principe de simplicité KISS", "description": "Le principe KISS (Keep it simple stupid) est un principe général d’ingénierie qui préconise la simplicité pour améliorer fiabilité, maintenance et évolutivité.", "url": "https://docs.redaction-technique.org/fr/costs/kiss-principle/", "markdown": "https://docs.redaction-technique.org/fr/costs/kiss-principle.md", "locale": "fr", "pageType": "topic", "contentType": "concept", "wordCount": 283, "headings": [ { "level": 2, "text": "Définition", "slug": "dfinition" }, { "level": 2, "text": "Exemples", "slug": "exemples" } ], "keywords": [], "tags": [] }, { "title": "Un index est-il utile dans un PDF ?", "description": "Un index est-il encore utile dans un PDF à l'ère de la recherche en plein texte ? Analyse des avantages et inconvénients pour la documentation technique et les PDF.", "url": "https://docs.redaction-technique.org/fr/costs/index-in-pdf/", "markdown": "https://docs.redaction-technique.org/fr/costs/index-in-pdf.md", "locale": "fr", "pageType": "topic", "contentType": "concept", "wordCount": 296, "headings": [ { "level": 2, "text": "Définition", "slug": "dfinition" }, { "level": 2, "text": "Compromis", "slug": "compromis" } ], "keywords": [], "tags": [] }, { "title": "Interroger la documentation", "description": "Décrivez votre besoin avec vos propres mots et obtenez une réponse fondée sur la documentation de ce site.", "url": "https://docs.redaction-technique.org/fr/ask/", "markdown": "https://docs.redaction-technique.org/fr/ask.md", "locale": "fr", "pageType": "utility", "contentType": null, "wordCount": 0, "headings": [], "keywords": [], "tags": [] }, { "title": "À propos de l'API de ce manuel", "description": "Ce manuel expose l'intégralité de son corpus sous forme d'API statique, sans exécution serveur, pour les LLM et agents IA — llms.txt, miroirs Markdown par page et index JSON. À quoi ça sert et comment l'utiliser.", "url": "https://docs.redaction-technique.org/fr/about-the-api/", "markdown": "https://docs.redaction-technique.org/fr/about-the-api.md", "locale": "fr", "pageType": "topic", "contentType": "reference", "wordCount": 1919, "headings": [ { "level": 2, "text": "Aperçu", "slug": "aperu" }, { "level": 2, "text": "Pourquoi elle existe", "slug": "pourquoi-elle-existe" }, { "level": 2, "text": "Flux de travail rapide (Quick start)", "slug": "flux-de-travail-rapide-quick-start" }, { "level": 2, "text": "Explorateur de documentation", "slug": "explorateur-de-documentation" }, { "level": 2, "text": "Endpoints", "slug": "endpoints" }, { "level": 2, "text": "Découverte automatique via /schema.json", "slug": "dcouverte-automatique-via-schemajson" }, { "level": 2, "text": "Métadonnées des documents et typage de l'information", "slug": "mtadonnes-des-documents-et-typage-de-linformation" }, { "level": 3, "text": "Distinction sémantique", "slug": "distinction-smantique" }, { "level": 3, "text": "Pages délibérément non typées", "slug": "pages-dlibrment-non-types" }, { "level": 3, "text": "Filtrage par paramètres d'URL", "slug": "filtrage-par-paramtres-durl" }, { "level": 2, "text": "Utilisation par les LLM et agents IA", "slug": "utilisation-par-les-llm-et-agents-ia" }, { "level": 3, "text": "Pourquoi le Markdown pour les consommateurs LLM ?", "slug": "pourquoi-le-markdown-pour-les-consommateurs-llm" }, { "level": 2, "text": "Exemples curl prêts à l'emploi", "slug": "exemples-curl-prts-lemploi" }, { "level": 3, "text": "1. Découvrir l'API et ses capacités", "slug": "1-dcouvrir-lapi-et-ses-capacits" }, { "level": 3, "text": "2. Lister les documents de tâches", "slug": "2-lister-les-documents-de-tches" }, { "level": 3, "text": "3. Réduire les champs renvoyés (projection économe en jetons)", "slug": "3-rduire-les-champs-renvoys-projection-conome-en-jetons" }, { "level": 3, "text": "4. Récupérer un document Markdown propre", "slug": "4-rcuprer-un-document-markdown-propre" }, { "level": 3, "text": "5. Paginer les résultats d'index", "slug": "5-paginer-les-rsultats-dindex" }, { "level": 2, "text": "Exemple consommateur en JavaScript", "slug": "exemple-consommateur-en-javascript" }, { "level": 2, "text": "Principes de stabilité de l'API et garanties contractuelles", "slug": "principes-de-stabilit-de-lapi-et-garanties-contractuelles" }, { "level": 2, "text": "Comment chaque page l'expose", "slug": "comment-chaque-page-lexpose" }, { "level": 2, "text": "Par rapport à « Interroger la documentation »", "slug": "par-rapport-interroger-la-documentation" }, { "level": 2, "text": "Références connexes", "slug": "rfrences-connexes" } ], "keywords": [], "tags": [] }, { "title": "Adopter le docs-as-code", "description": "Traiter la documentation comme du code : Git, Markdown, pull requests, CI/CD et pipelines de publication statique.", "url": "https://docs.redaction-technique.org/fr/docs-as-code/", "markdown": "https://docs.redaction-technique.org/fr/docs-as-code.md", "locale": "fr", "pageType": "landing", "contentType": null, "wordCount": 48, "headings": [ { "level": 2, "text": "Processus et outillage", "slug": "processus-et-outillage" }, { "level": 2, "text": "Didacticiels pratiques", "slug": "didacticiels-pratiques" } ], "keywords": [], "tags": [] }, { "title": "Apprendre la rédaction technique", "description": "Principes fondamentaux, terminologie et approche centrée sur l'audience pour qui débute en rédaction technique — ou souhaite affiner sa pratique.", "url": "https://docs.redaction-technique.org/fr/learn/", "markdown": "https://docs.redaction-technique.org/fr/learn.md", "locale": "fr", "pageType": "landing", "contentType": null, "wordCount": 74, "headings": [], "keywords": [], "tags": [] }, { "title": "Check-list : adoption du docs-as-code", "description": "Une check-list pour faire migrer une équipe documentaire vers un workflow docs-as-code - gestion de versions, formats texte, CI/CD et préparation de l'équipe.", "url": "https://docs.redaction-technique.org/fr/toolkit/docs-as-code-adoption-checklist/", "markdown": "https://docs.redaction-technique.org/fr/toolkit/docs-as-code-adoption-checklist.md", "locale": "fr", "pageType": "topic", "contentType": "reference", "wordCount": 365, "headings": [ { "level": 2, "text": "Format", "slug": "format" }, { "level": 2, "text": "Gestion de versions", "slug": "gestion-de-versions" }, { "level": 2, "text": "CI/CD", "slug": "cicd" }, { "level": 2, "text": "Processus de revue", "slug": "processus-de-revue" }, { "level": 2, "text": "Préparation de l'équipe", "slug": "prparation-de-lquipe" } ], "keywords": [], "tags": [] }, { "title": "Check-list : audit documentaire", "description": "Une check-list pour auditer un ensemble documentaire existant - repérer les pages orphelines, le contenu en doublon, les liens cassés et une architecture d'information obsolète.", "url": "https://docs.redaction-technique.org/fr/toolkit/documentation-audit-checklist/", "markdown": "https://docs.redaction-technique.org/fr/toolkit/documentation-audit-checklist.md", "locale": "fr", "pageType": "topic", "contentType": "reference", "wordCount": 438, "headings": [ { "level": 2, "text": "Accessibilité", "slug": "accessibilit" }, { "level": 2, "text": "Doublons", "slug": "doublons" }, { "level": 2, "text": "Fraîcheur", "slug": "fracheur" }, { "level": 2, "text": "Structure", "slug": "structure" }, { "level": 2, "text": "Liens", "slug": "liens" }, { "level": 2, "text": "Résultat", "slug": "rsultat" } ], "keywords": [], "tags": [] }, { "title": "Check-list : migration documentaire", "description": "Une check-list pour migrer une documentation entre formats ou plateformes sans perdre de contenu, casser d'URL ou dégrader la structure - basée sur une vraie migration DITA XML.", "url": "https://docs.redaction-technique.org/fr/toolkit/documentation-migration-checklist/", "markdown": "https://docs.redaction-technique.org/fr/toolkit/documentation-migration-checklist.md", "locale": "fr", "pageType": "topic", "contentType": "reference", "wordCount": 421, "headings": [ { "level": 2, "text": "Avant de migrer", "slug": "avant-de-migrer" }, { "level": 2, "text": "Pendant la migration", "slug": "pendant-la-migration" }, { "level": 2, "text": "Après la migration", "slug": "aprs-la-migration" }, { "level": 2, "text": "Déploiement", "slug": "dploiement" } ], "keywords": [], "tags": [] }, { "title": "Check-list : préparation à la mise en production", "description": "Une check-list de contrôle pour savoir si la documentation est prête à sortir avec une version du produit - couverture, exactitude, traduction et livraison.", "url": "https://docs.redaction-technique.org/fr/toolkit/release-readiness-checklist/", "markdown": "https://docs.redaction-technique.org/fr/toolkit/release-readiness-checklist.md", "locale": "fr", "pageType": "topic", "contentType": "reference", "wordCount": 283, "headings": [ { "level": 2, "text": "Couverture", "slug": "couverture" }, { "level": 2, "text": "Exactitude", "slug": "exactitude" }, { "level": 2, "text": "Traduction", "slug": "traduction" }, { "level": 2, "text": "Livraison", "slug": "livraison" }, { "level": 2, "text": "Validation finale", "slug": "validation-finale" } ], "keywords": [], "tags": [] }, { "title": "Check-list : qualité documentaire", "description": "Une check-list de pré-publication couvrant l'exactitude, la structure et l'accessibilité pour une page documentaire - à exécuter avant de fusionner tout changement de contenu.", "url": "https://docs.redaction-technique.org/fr/toolkit/documentation-quality-checklist/", "markdown": "https://docs.redaction-technique.org/fr/toolkit/documentation-quality-checklist.md", "locale": "fr", "pageType": "topic", "contentType": "reference", "wordCount": 360, "headings": [ { "level": 2, "text": "Exactitude", "slug": "exactitude" }, { "level": 2, "text": "Structure", "slug": "structure" }, { "level": 2, "text": "Rédaction", "slug": "rdaction" }, { "level": 2, "text": "Accessibilité", "slug": "accessibilit" }, { "level": 2, "text": "Avant de fusionner", "slug": "avant-de-fusionner" } ], "keywords": [], "tags": [] }, { "title": "Check-list : revue technique", "description": "Une check-list pour l'expert métier qui relit un changement documentaire pour en vérifier l'exactitude technique - ce qu'il faut vérifier, et ce qui n'est explicitement pas son rôle.", "url": "https://docs.redaction-technique.org/fr/toolkit/technical-review-checklist/", "markdown": "https://docs.redaction-technique.org/fr/toolkit/technical-review-checklist.md", "locale": "fr", "pageType": "topic", "contentType": "reference", "wordCount": 302, "headings": [ { "level": 2, "text": "Ce que vous vérifiez", "slug": "ce-que-vous-vrifiez" }, { "level": 2, "text": "Ce qui n'est explicitement pas votre rôle", "slug": "ce-qui-nest-explicitement-pas-votre-rle" }, { "level": 2, "text": "Comment transmettre vos retours", "slug": "comment-transmettre-vos-retours" }, { "level": 2, "text": "Après la revue", "slug": "aprs-la-revue" } ], "keywords": [], "tags": [] }, { "title": "Choisir outils et formats", "description": "Outils, formats, compromis et critères de sélection pour la documentation technique.", "url": "https://docs.redaction-technique.org/fr/tools-and-formats/", "markdown": "https://docs.redaction-technique.org/fr/tools-and-formats.md", "locale": "fr", "pageType": "landing", "contentType": null, "wordCount": 49, "headings": [], "keywords": [], "tags": [] }, { "title": "Construire un processus documentaire", "description": "Planification, rédaction, révision, gouvernance et maintenance — un processus explicite et reproductible pour produire de la documentation technique.", "url": "https://docs.redaction-technique.org/fr/process/", "markdown": "https://docs.redaction-technique.org/fr/process.md", "locale": "fr", "pageType": "landing", "contentType": null, "wordCount": 64, "headings": [], "keywords": [], "tags": [] }, { "title": "Exemple : un pipeline CI/CD concret pour la documentation", "description": "Un exemple abouti de pipeline CI/CD documentaire - build, vérification de liens, index de recherche et déploiement - annoté étape par étape.", "url": "https://docs.redaction-technique.org/fr/toolkit/example-cicd-pipeline/", "markdown": "https://docs.redaction-technique.org/fr/toolkit/example-cicd-pipeline.md", "locale": "fr", "pageType": "topic", "contentType": "task", "wordCount": 365, "headings": [ { "level": 2, "text": "Le pipeline", "slug": "le-pipeline" }, { "level": 2, "text": "Ce que chaque étape détecte, et pourquoi cet ordre", "slug": "ce-que-chaque-tape-dtecte-et-pourquoi-cet-ordre" }, { "level": 2, "text": "Ce que ce pipeline ne fait délibérément pas", "slug": "ce-que-ce-pipeline-ne-fait-dlibrment-pas" } ], "keywords": [], "tags": [] }, { "title": "Exemple : un workflow de revue documentaire", "description": "Un exemple abouti d'acheminement d'un changement documentaire à travers une revue technique puis éditoriale avant publication, avec des responsabilités clairement séparées.", "url": "https://docs.redaction-technique.org/fr/toolkit/example-review-workflow/", "markdown": "https://docs.redaction-technique.org/fr/toolkit/example-review-workflow.md", "locale": "fr", "pageType": "topic", "contentType": "task", "wordCount": 459, "headings": [ { "level": 2, "text": "Le scénario", "slug": "le-scnario" }, { "level": 2, "text": "Le workflow", "slug": "le-workflow" }, { "level": 2, "text": "Pourquoi la revue est scindée en deux passes", "slug": "pourquoi-la-revue-est-scinde-en-deux-passes" } ], "keywords": [], "tags": [] }, { "title": "Exemple : un workflow docs-as-code basique", "description": "Un exemple abouti d'un changement documentaire unique, de la branche à la fusion, sous un workflow docs-as-code calqué sur une revue de code standard.", "url": "https://docs.redaction-technique.org/fr/toolkit/example-docs-as-code-workflow/", "markdown": "https://docs.redaction-technique.org/fr/toolkit/example-docs-as-code-workflow.md", "locale": "fr", "pageType": "topic", "contentType": "task", "wordCount": 461, "headings": [ { "level": 2, "text": "Le scénario", "slug": "le-scnario" }, { "level": 2, "text": "Le workflow", "slug": "le-workflow" }, { "level": 2, "text": "Pourquoi cela fonctionne", "slug": "pourquoi-cela-fonctionne" } ], "keywords": [], "tags": [] }, { "title": "Exemple : une architecture de dépôt documentaire", "description": "Un exemple abouti d'organisation d'un dépôt docs-as-code - contenu par type d'information, langue en premier niveau pour un site traduit, et séparation nette de l'outillage.", "url": "https://docs.redaction-technique.org/fr/toolkit/example-repository-structure/", "markdown": "https://docs.redaction-technique.org/fr/toolkit/example-repository-structure.md", "locale": "fr", "pageType": "topic", "contentType": "reference", "wordCount": 304, "headings": [ { "level": 2, "text": "L'arborescence", "slug": "larborescence" }, { "level": 2, "text": "Pourquoi cette forme", "slug": "pourquoi-cette-forme" }, { "level": 2, "text": "Ce qui n'a pas sa place dans ce dépôt", "slug": "ce-qui-na-pas-sa-place-dans-ce-dpt" } ], "keywords": [], "tags": [] }, { "title": "Exemple : une page Markdown bien structurée", "description": "Un exemple abouti d'article concept en Markdown, annoté pour expliquer pourquoi chaque choix structurel a été fait.", "url": "https://docs.redaction-technique.org/fr/toolkit/example-markdown-page/", "markdown": "https://docs.redaction-technique.org/fr/toolkit/example-markdown-page.md", "locale": "fr", "pageType": "topic", "contentType": "task", "wordCount": 208, "headings": [ { "level": 2, "text": "La source", "slug": "la-source" }, { "level": 2, "text": "Pourquoi cette page est structurée ainsi", "slug": "pourquoi-cette-page-est-structure-ainsi" } ], "keywords": [], "tags": [] }, { "title": "Explorer la référence", "description": "Glossaire, concepts, commandes et détails techniques pour une consultation rapide plutôt qu'une lecture linéaire.", "url": "https://docs.redaction-technique.org/fr/reference/", "markdown": "https://docs.redaction-technique.org/fr/reference.md", "locale": "fr", "pageType": "overview", "contentType": null, "wordCount": 42, "headings": [], "keywords": [], "tags": [] }, { "title": "Glossaire", "description": "Définitions des termes de rédaction technique et de rédaction structurée utilisés dans ce manuel, chacun relié à l'article qui l'approfondit.", "url": "https://docs.redaction-technique.org/fr/reference/glossary/", "markdown": "https://docs.redaction-technique.org/fr/reference/glossary.md", "locale": "fr", "pageType": "topic", "contentType": "reference", "wordCount": 679, "headings": [ { "level": 2, "text": "Aperçu", "slug": "aperu" }, { "level": 2, "text": "Termes", "slug": "termes" }, { "level": 2, "text": "Références connexes", "slug": "rfrences-connexes" } ], "keywords": [], "tags": [] }, { "title": "Modèle : article concept", "description": "Un modèle de rédaction prêt à l'emploi pour concevoir un article concept — un type d'information répondant à « Qu'est-ce que c'est ? » avec définitions, contexte, principes et exemples.", "url": "https://docs.redaction-technique.org/fr/toolkit/concept-article-template/", "markdown": "https://docs.redaction-technique.org/fr/toolkit/concept-article-template.md", "locale": "fr", "pageType": "topic", "contentType": "reference", "wordCount": 575, "headings": [ { "level": 2, "text": "Qu'est-ce qu'un Concept ?", "slug": "quest-ce-quun-concept" }, { "level": 2, "text": "Quand utiliser un Concept", "slug": "quand-utiliser-un-concept" }, { "level": 2, "text": "Maîtriser les frontières de contenu", "slug": "matriser-les-frontires-de-contenu" }, { "level": 2, "text": "Structure recommandée", "slug": "structure-recommande" }, { "level": 2, "text": "Quand omettre une section", "slug": "quand-omettre-une-section" } ], "keywords": [], "tags": [] }, { "title": "Modèle : article référence", "description": "Un modèle Markdown prêt à copier pour rédiger un article référence, selon la structure Aperçu / Syntaxe / Paramètres / Exemples / Limitations.", "url": "https://docs.redaction-technique.org/fr/toolkit/reference-article-template/", "markdown": "https://docs.redaction-technique.org/fr/toolkit/reference-article-template.md", "locale": "fr", "pageType": "topic", "contentType": "reference", "wordCount": 245, "headings": [ { "level": 2, "text": "Quand omettre une section", "slug": "quand-omettre-une-section" } ], "keywords": [], "tags": [] }, { "title": "Modèle : article tâche", "description": "Un modèle Markdown prêt à copier pour rédiger un article tâche/didacticiel, selon la structure Objectif / Prérequis / Étapes / Résultat attendu / Dépannage.", "url": "https://docs.redaction-technique.org/fr/toolkit/task-article-template/", "markdown": "https://docs.redaction-technique.org/fr/toolkit/task-article-template.md", "locale": "fr", "pageType": "topic", "contentType": "reference", "wordCount": 206, "headings": [ { "level": 2, "text": "Quand omettre une section", "slug": "quand-omettre-une-section" } ], "keywords": [], "tags": [] }, { "title": "Modèle : demande de revue documentaire", "description": "Un modèle de demande prêt à copier pour solliciter la revue d'un expert métier ou d'un relecteur technique, avec un périmètre et une échéance clairs.", "url": "https://docs.redaction-technique.org/fr/toolkit/documentation-review-request-template/", "markdown": "https://docs.redaction-technique.org/fr/toolkit/documentation-review-request-template.md", "locale": "fr", "pageType": "topic", "contentType": "reference", "wordCount": 174, "headings": [ { "level": 2, "text": "Notes de remplissage", "slug": "notes-de-remplissage" } ], "keywords": [], "tags": [] }, { "title": "Modèle : documentation d'API", "description": "Un modèle Markdown prêt à copier pour documenter un endpoint d'API REST - aperçu, méthode, paramètres, exemples de requête/réponse et codes d'erreur.", "url": "https://docs.redaction-technique.org/fr/toolkit/api-documentation-template/", "markdown": "https://docs.redaction-technique.org/fr/toolkit/api-documentation-template.md", "locale": "fr", "pageType": "topic", "contentType": "reference", "wordCount": 239, "headings": [ { "level": 2, "text": "Notes de remplissage", "slug": "notes-de-remplissage" } ], "keywords": [], "tags": [] }, { "title": "Modèle : plan de projet documentaire", "description": "Un plan de projet prêt à copier pour cadrer un projet de documentation technique avant le début de la rédaction - objectif, public, périmètre et critères de succès.", "url": "https://docs.redaction-technique.org/fr/toolkit/documentation-project-plan-template/", "markdown": "https://docs.redaction-technique.org/fr/toolkit/documentation-project-plan-template.md", "locale": "fr", "pageType": "topic", "contentType": "reference", "wordCount": 36, "headings": [], "keywords": [], "tags": [] }, { "title": "Typologie de l'information", "description": "Comprendre la typologie de l'information en rédaction technique : comment Concept, Tâche et Référence structurent le contenu selon l'intention du lecteur, et comment ce principe s'articule avec DITA, Markdown et OpenAPI.", "url": "https://docs.redaction-technique.org/fr/toolkit/information-types/", "markdown": "https://docs.redaction-technique.org/fr/toolkit/information-types.md", "locale": "fr", "pageType": "topic", "contentType": "concept", "wordCount": 1978, "headings": [ { "level": 2, "text": "Définition", "slug": "dfinition" }, { "level": 3, "text": "Les trois types en pratique", "slug": "les-trois-types-en-pratique" }, { "level": 3, "text": "Intention principale et frontières de contenu", "slug": "intention-principale-et-frontires-de-contenu" }, { "level": 2, "text": "Distinctions clés : hiérarchie terminologique", "slug": "distinctions-cls-hirarchie-terminologique" }, { "level": 2, "text": "Métadonnées frontmatter : contentType", "slug": "mtadonnes-frontmatter-contenttype" }, { "level": 2, "text": "Typologie de l'information et DITA", "slug": "typologie-de-linformation-et-dita" }, { "level": 3, "text": "Compromis d'ingénierie : DITA et le docs-as-code", "slug": "compromis-dingnierie-dita-et-le-docs-as-code" }, { "level": 2, "text": "Comparatif pratique", "slug": "comparatif-pratique" }, { "level": 3, "text": "DITA et OpenAPI en perspective", "slug": "dita-et-openapi-en-perspective" }, { "level": 2, "text": "Typologie de l'information et documentation d'API", "slug": "typologie-de-linformation-et-documentation-dapi" }, { "level": 3, "text": "Les trois types dans les portails d'API", "slug": "les-trois-types-dans-les-portails-dapi" }, { "level": 3, "text": "OpenAPI et la couche de référence", "slug": "openapi-et-la-couche-de-rfrence" }, { "level": 2, "text": "Ressources connexes de la boîte à outils", "slug": "ressources-connexes-de-la-bote-outils" } ], "keywords": [], "tags": [] }, { "title": "Utiliser la boîte à outils", "description": "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.", "url": "https://docs.redaction-technique.org/fr/toolkit/", "markdown": "https://docs.redaction-technique.org/fr/toolkit.md", "locale": "fr", "pageType": "landing", "contentType": null, "wordCount": 42, "headings": [ { "level": 2, "text": "Socle méthodologique", "slug": "socle-mthodologique" }, { "level": 2, "text": "Modèles", "slug": "modles" }, { "level": 2, "text": "Check-lists", "slug": "check-lists" }, { "level": 2, "text": "Exemples", "slug": "exemples" } ], "keywords": [], "tags": [] }, { "title": "Utiliser la rédaction structurée", "description": "DITA XML, typage de l'information, réutilisation de contenu et modèles de contenu modulaires — avec des études de cas réelles.", "url": "https://docs.redaction-technique.org/fr/structured-authoring/", "markdown": "https://docs.redaction-technique.org/fr/structured-authoring.md", "locale": "fr", "pageType": "landing", "contentType": null, "wordCount": 44, "headings": [ { "level": 2, "text": "Formats et architecture", "slug": "formats-et-architecture" }, { "level": 2, "text": "Didacticiels", "slug": "didacticiels" } ], "keywords": [], "tags": [] } ] }