Aller au contenu principal

Introduction

Bienvenue dans mon portefeuille de documentation​

Cette section de mon portefeuille Docs-as-Code offre un aperçu complet d'échantillons de documentation technique, tous rédigés et publiés entièrement en Markdown à l'aide de Docusaurus. Vous trouverez ici des exemples de guides de développement, de références d'API, ainsi qu'un aperçu des flux de travail utilisés pour les créer.

Guides

Références API

Conceptuel/Overview Docs

Pour voir les fichiers markdown bruts de ces documents, rendez-vous sur GitHub.

Flux de travail​

  • Rédaction avec Markdown dans VS Code
  • Linting Markdown avec Vale
  • Traduction avec DeepL
  • Création de diagrammes avec Mermaid
  • Versionnement des documents avec Git
  • Validation d'API avec Postman et Swagger/OpenAPI
  • Publication avec Docusaurus

Outils​

  • Docusaurus : Pour générer le site statique et la documentation.
  • VS Code : Editeur principal pour tout le contenu.
  • Postman : Pour les tests de l'API et la génération d'exemples de documentation de l'API.
  • Vale : Pour le linting et s'assurer de l'adhésion au guide de style.
  • Git/GitHub : Pour le contrôle des versions et l'hébergement.
  • Mermaid Chart : Conversion du code Mermaid en images.
  • DeepL : Pour la traduction de la documentation en plusieurs langues.

Cela reflète la façon dont les équipes professionnelles maintiennent les portails de documentation des développeurs tels que Docusaurus ou des générateurs de sites statiques similaires.

Chaque exemple illustre la création d'un document de bout en bout : recherche → rédaction → révision → publication.