Docs-as-code

• Check-list : adoption du docs-as-code

  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.

• Exemple : un pipeline CI/CD concret pour la documentation

  Un exemple abouti de pipeline CI/CD documentaire - build, vérification de liens, index de recherche et déploiement - annoté étape par étape.

• Exemple : un workflow docs-as-code basique

  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.

• Exemple : une architecture de dépôt documentaire

  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.

• Git : du fichier au contenu

  Pensez contenu plutôt que fichiers avec Git : branches, commits et diffs pour la documentation technique simplifient la collaboration et la gestion des versions.

• Intégrer la documentation aux processus de développement

  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.

• Les systèmes de gestion de versions - rustiques mais fiables

  Gérez la documentation technique avec Git ou Subversion comme du code source : suivez les modifications, collaborez en équipe et restaurez des versions.

← Tous les thèmes