Introduction
Bienvenue dans mon portfolio de documentation
Cette section de mon portfolio de rédaction technique offre un aperçu complet d'exemples de documentation logicielle, 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 API et des informations sur les workflows utilisés pour les créer.
Guides de navigation
- Installation et application d'un thème à Google Chrome
- Utilisation de Postman pour se connecter à l'API Stripe
- Microsoft Word vers GitHub Wiki Workflow avec Writage
- Acheminer les journaux d'applications cloud vers un pipeline
- Tutoriel : récupération des données d'objet
- Tutoriel : envoi d'une transaction
Références API
- Documentation API Stripe
- Documentation API Pet Store
- Ingestion d'événements via l'API Streaming
- SuiClient: getObject
- SuiClient: multiGetObjects
- SuiClient: getOwnedObjects
Documents conceptuels/généraux
Pour consulter 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
- Gestion des versions des documents avec Git
- Validation de l'API avec Postman et Swagger/OpenAPI
- Publication avec Docusaurus
Outils
- Docusaurus : pour générer le site statique et la documentation.
- VS Code : éditeur principal pour tout le contenu.
- Postman : pour tester l'API et générer des exemples de documentation API.
- Vale : pour le linting et la garantie du respect du guide de style.
- Git/GitHub : pour le contrôle de version et l'hébergement.
- Mermaid Chart : pour la conversion du code Mermaid en images.
- DeepL MCP : pour la traduction de la documentation en plusieurs langues.
Cela reflète la manière dont les équipes professionnelles gèrent les portails de documentation pour développeurs tels que Docusaurus ou d'autres générateurs de sites statiques similaires.
Chaque élément illustre le processus complet de création de documentation : recherche → rédaction → révision → publication.