Articles avec le tag: Outils
Sphinx, MkDocs, Astro et les autres générateurs optimisent des modèles de contenu et des équipes différents. Choisissez selon le workflow, l’extensibilité, la localisation et le coût de maintenance, pas selon une jolie démo. Une démonstration superbe peut être mauvaise pour votre documentation.
Une approche pratique et vérifiable de « Choisir la recherche documentaire : commencer par les échecs », conçue pour une documentation claire et maintenable. Comment traiter « Choisir la recherche documentaire : commencer par les échecs » avec une approche pratique, vérifiable et maintenable de la documentation technique.
Une approche pratique et vérifiable de « Diagrammes as code : quand ils aident et quand ils n’aident pas », conçue pour une documentation claire et maintenable. Comment traiter « Diagrammes as code : quand ils aident et quand ils n’aident pas » avec une approche pratique, vérifiable et maintenable de la documentation technique.
Les formats et pipelines ont radicalement changé, mais les problèmes durables restent familiers : source control, reuse, navigation, review et synchronisation entre produit et information publiée. Bien avant le terme Docs-as-Code, les équipes géraient plusieurs sources, des fragments réutilisés, des versions et la question de savoir quelle copie était actuelle.
Traitez la documentation comme un artefact de build : validez structure, liens, exemples et règles avant publication. La CI ne peut pas juger l’utilité d’une explication, mais elle peut bloquer des défauts prévisibles avant de consommer du temps humain.
Une approche pratique et vérifiable de « Markdown à grande échelle : des conventions contre le chaos », conçue pour une documentation claire et maintenable. Comment traiter « Markdown à grande échelle : des conventions contre le chaos » avec une approche pratique, vérifiable et maintenable de la documentation technique.
Le linting éditorial est utile lorsqu’il détecte la dérive terminologique, les formulations risquées et les défauts répétitifs. Gardez peu de règles, explicables et assez silencieuses pour qu’un échec soit pris au sérieux. Un linter peut contrôler des milliers de phrases en quelques secondes, ce qui donne envie d'encoder chaque préférence éditoriale.
Une approche pratique et vérifiable de « Quand les manuels étaient livrés sur CD », conçue pour une documentation claire et maintenable. Comment traiter « Quand les manuels étaient livrés sur CD » avec une approche pratique, vérifiable et maintenable de la documentation technique.