3 articles tagués avec « Docs-as-code »

Il y a quelque temps, quelqu’un m’a demandé quel outil j’utilisais pour la documentation technique — et au lieu d’en choisir un seul, j’ai réalisé que ma configuration est plutôt un trio créatif.
J’écris en Markdown, je construis avec Docusaurus, et je dessine avec Excalidraw. Dans cet article, je partage pourquoi cette combinaison fonctionne si bien pour moi et comment elle rend l’écriture à la fois simple et puissante.

Pendant des années, la documentation n’arrivait qu’après le développement. La méthode consistait à collecter des informations — parfois directement auprès des développeurs, mais le plus souvent dans notre propre bulle, entre rédacteurs techniques. Puis un jour, j’ai réalisé quelque chose : j’utilisais Git, j’écrivais en Markdown, je poussais des commits, j’éditais dans VS Code. Attends une minute — je faisais du docs-as-code.

Cet été, je me suis replongée dans la documentation d’un client avec une double mission : expliquer leur nouvelle API et migrer l’ensemble du site vers Docusaurus V2.
Du moteur de recherche aux admonitions stylisées en passant par l’intégration ReDoc, cette version ne se contente pas d’être belle — elle fonctionne brillamment. Voici ce que nous y avons gagné, et ce à quoi il faut faire attention.