Portfolio de rédaction technique

Il s'agit d'un portfolio dédié exclusivement aux échantillons liés aux logiciels de mon portfolio de rédaction technique. Il offre un aperçu complet des échantillons 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 pour les développeurs, des références d'API et des informations sur les flux de travail utilisés pour les créer.

note

Je ne peux pas partager la majeure partie de mon travail en raison d'accords de confidentialité (NDA), mais ce portfolio comprende du contenu original qui démontre mes compétences et processus de rédaction technique.

Navigation dans le portfolio

Guides

• Installation et application d'un thème à Google Chrome
• Utilisation de Postman pour se connecter à l'API Stripe
• Flux de travail Microsoft Word vers GitHub Wiki avec Writage
• Acheminement des journaux d'applications cloud vers un pipeline
• Tutoriel : Récupération de données d'objet
• Tutoriel : Envoi d'une transaction

Références d'API

• Documentation de l'API Stripe
• Documentation de l'API Pet Store
• Ingestion d'événements via l'API de streaming
• SuiClient : getObject
• SuiClient : multiGetObjects
• SuiClient : getOwnedObjects

Documents Conceptuels/Aperçu

• Flux d'événements et pipelines d'observabilité
• Avant de commencer
• L'architecture SuiClient

Pour consulter les fichiers Markdown bruts de ces documents, rendez-vous sur GitHub.

Flux de travail de documentation

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

Pile technique

• Docusaurus : Pour générer le site statique et la documentation.
• VS Code : Éditeur principal pour tout le contenu.
• Postman : Pour les tests d'API et la génération d'exemples de documentation d'API.
• Vale : Pour le contrôle et le respect du guide de style.
• Git/GitHub : Pour le contrôle de version et l'hébergement.
• Mermaid Chart : Conversion du code Mermaid en images.
• DeepL MCP : Pour la traduction de la documentation dans 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 des générateurs de sites statiques similaires.

Chaque pièce démontre la création de documents de bout en bout : recherche → rédaction → révision → publication.