Portfolio de rédaction technique
Ce portfolio est exclusivement consacré aux exemples liés aux logiciels de mon portfolio de rédaction technique. Il 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 y trouverez des exemples de guides de développement, de références API, ainsi que des informations sur les workflows utilisés pour les créer.
Navigation dans le portfolio
Explorez les exemples de documentation organisés par type de livrable et par domaine :
Guides pour développeurs et guides système
- Installation et application d’un thème à Google Chrome. Un guide pas à pas de personnalisation du navigateur avec onglets interactifs et mise en page réactive.
- Workflow de Microsoft Word vers GitHub Wiki avec Writage. Un guide pour rédiger en Markdown dans Word, cloner des wikis avec GitHub Desktop et publier des révisions.
- Utilisation de Postman pour se connecter à l’API Stripe. Un guide pour s'authentifier et effectuer des requêtes API dans Postman.
- Créer un serveur fictif Postman. Un tutoriel pratique pour configurer des serveurs fictifs afin de tester les intégrations de webhooks et les schémas d'API.
- Acheminer les journaux d’une application cloud vers un pipeline. Une procédure opérationnelle pour ingérer et filtrer la télémétrie des applications cloud.
- Comment récupérer les données d'un objet. Un tutoriel expliquant les requêtes de lecture RPC avec le SDK TypeScript pour Sui.
- Utiliser une opération d'écriture pour envoyer une transaction. Un guide pour développeurs sur la signature et la diffusion de transactions programmables.
Références API
- Documentation de l'API Stripe. Référence d'API pour les fintechs et l'infrastructure de paiement.
- Documentation de l'API Pet Store. Référence modulaire d'API REST modélisée d'après la spécification OpenAPI 3.0.
- API d'ingestion de journaux Datadog. Référence d'API de streaming pour soumettre des données de télémétrie par lots.
- Référence du SDK TypeScript pour Sui :
Architecture et documentation conceptuelle
- Introduction à l'API Stripe. Vue d'ensemble conceptuelle de l'infrastructure financière, des entités principales et de l'authentification.
- Introduction à l'API Pet Store. Aperçu du service REST Petstore avec Swagger/OpenAPI et des protocoles d'authentification.
- Flux d'événements et pipelines d'observabilité. Aperçu architectural du traitement des flux, du routage en périphérie et de la transformation des données.
- Avant de commencer avec les pipelines d'observabilité. Guide architectural comparant les paradigmes de routage des journaux pour les systèmes d'entreprise.
- L'architecture SuiClient. Modèle conceptuel expliquant comment les clients RPC distribués orchestrent les requêtes d'état.
Messages de commit et pull requests
- Correction des tableaux ordonnés selon l'ordre F dans NumPy. Description de pull request open source et message de commit résolvant les problèmes de disposition en mémoire des tableaux.
- Dérivation via ak.mean dans JAX. Documentation et message de commit expliquant la prise en charge de la différentiation automatique dans Awkward Array.
Études de cas
- Étude de cas sur l'assistant d'IA Ask Artie. Une étude de cas d'ingénierie analysant l'ingénierie des invites, la sécurité OWASP LLM et l'architecture de récupération RAG.
Pour consulter les fichiers Markdown bruts de ces documents, visitez le dépôt GitHub.
Workflow « Docs-as-code »
- Rédaction en Markdown et MDX avec VS Code et Antigravity
- Contrôle de la prose et du style avec Vale
- Internationalisation et traduction avec DeepL et Lara
- Création de diagrammes d'architecture système avec Mermaid
- Gestion des versions et révision collaborative du code avec Git et GitHub
- Exploration et validation des API avec Postman et Swagger/OpenAPI
- Déploiement continu avec Docusaurus
Pile technique
- Docusaurus. Génère des sites statiques, des barres latérales de navigation et des versions localisées.
- VS Code. Sert d'éditeur principal pour la rédaction en Markdown et MDX.
- Postman. Valide les points de terminaison d'API et génère des exemples de requêtes et de réponses.
- Vale. Analyse la prose technique pour faire respecter le guide de style Google Developer Documentation.
- Git et GitHub. Gère le contrôle de version par branches et le déploiement du site.
- Mermaid. Génère des organigrammes et des diagrammes d'architecture de pipelines de données.
- DeepL et Lara. Automatisent la traduction de documentation dans plusieurs langues.
Cet environnement reflète les portails de développement en production des entreprises d'ingénierie modernes.
Chaque exemple reflète le cycle complet de création documentaire : recherche, rédaction, tests, révision et publication.