Automatisation et techniques spécialisées

Guides pratiques couvrant l’outillage documentaire, l’automatisation du single-sourcingSingle-sourcingGénérer plusieurs livrables (PDF, HTML, formats d'aide) à partir d'une source unique, plutôt que de maintenir une source séparée par format de sortie.Voir dans le glossaire →, la rédaction structuréeRédaction structuréeRédiger un contenu dont le balisage encode le sens (ceci est un avertissement, ceci est une étape) plutôt que la seule apparence visuelle — permettant un traitement automatisé, une réutilisation et des contrôles de cohérence que les formats non structurés ne permettent pas.Voir dans le glossaire → et les chaînes de publication multi-formats.

10 articles·

Tâche10

Note

Ces didacticiels présentent des techniques de mise en œuvre spécialisées ou historiques - Jinja, Python, sed, Sphinx/ReST, XSL-FO et le Raspberry Pi. Ce ne sont pas des choix recommandés par défaut pour un nouveau projet documentaire ; pour les pratiques actuelles, voir adopter le docs-as-code et choisir un modèle de rédaction.

Rédaction structurée et publication multicanal

Méthodes de filtrage, de profilage et de transformation de sources uniques vers de multiples livrables.

Didacticiels DITA XML et XSL-FODidacticiels pas à pas pour rédiger en DITA XML et générer des PDF avec des feuilles de style XSL-FO.

Créer des documents différents à partir des mêmes sources via Jinja (méthode objet)Définissez l’audience, la plateforme et la version comme des objets Python, puis laissez Jinja filtrer votre contenu à la compilation - plus propre que des flags à base de chaînes de caractères.

Créer des documents différents à partir des mêmes sources via JinjaUn script Python de preprocessing qui utilise des templates Jinja pour inclure ou supprimer des sections de contenu avant de passer les sources à votre générateur de documentation.

Créer des documents différents à partir des mêmes sources ReST (texte conditionnel)Générer des variantes de documents à partir des mêmes sources ReST avec le texte conditionnel de Sphinx.

Automatisation de contenu et intégration de données

Techniques d’extraction de données et d’injection dynamique depuis des bases SQL directement dans vos sources documentaires.

Insérer automatiquement des données dans un fichier DITA XMLAutomatisez la génération de fichiers DITA XML avec Python en insérant des données produit dynamiques dans vos topics DITA.

Insérer automatiquement des données dans un fichier reStructuredTextCréez un template reStructuredText que Python renseigne en noms de produits et versions à la compilation - plus aucune mise à jour manuelle à chaque version.

Insérer automatiquement des données SQL dans un fichier reStructuredTextInterrogez une base de données produit et injectez directement les résultats dans un fichier reStructuredText - gardez la documentation synchronisée avec la source de vérité.

Traitement de texte et outillage technique

Manipulation de texte en ligne de commande, refactorisation par lots et infrastructure légère pour vos pipelines documentaires.

sed : modifiez votre texte sans ouvrir vos fichiersEffectuez des recherches et remplacements ciblés dans des centaines de fichiers de documentation en une seule commande - comment sed gère les modifications de texte en masse sans ouvrir un seul fichier.

Expressions régulières en PythonLa bibliothèque d’expressions régulières de Python aide à manipuler du texte, notamment si vous n’êtes pas familier avec sed ou awk.

Le Raspberry Pi 3 en tant que plateforme de documentationAvec ses ressources modestes, un Raspberry Pi 3 suffit pour créer, gérer et générer une documentation en PDF, HTML ou EPUB.

Mener un projet de bout en boutDes milliers de photos dispersées sur des dizaines d'ordinateurs, un budget de zéro euro et une archive centralisée : un projet suivi de la prise en charge à la livraison.