Bien que les CCMS empruntent quelques astuces à la boîte à outils du docs-as-code, comme la modularité et l'automatisation, ils sont fermement ancrés dans la rédaction technique classique. Les outils CCMS sont conçus pour les auteurs, et non pour les développeurs, et cela fait toute la différence.
Fort de plus de 20 ans d'expérience, j'adopte une approche full-stack de la rédaction technique, des API et SDK back-end aux interfaces utilisateur front-end. Je combine proximité du développement et scénarios utilisateurs pour fournir une documentation claire et utile.
Un tableau comparatif qui met en évidence les principales différences entre la rédaction technique classique et la méthodologie docs-as-code, deux approches que j’ai maîtrisées pour m’adapter aux divers besoins des projets.
DOCful est un concept de documentation centré sur le développeur, introduit par Florence Venisse en 2019 et inspiré des principes RESTful. Il améliore la documentation des API REST en combinant des documents de référence structurés et des instructions intuitives et conviviales, le tout en accord avec l'approche docs-as-code.