Portfolio de rédaction technique
Ce site rassemble les exemples de documentation logicielle du portfolio de rédaction technique. Docusaurus génère chaque page à partir de sources Markdown et MDX. L’ensemble couvre des guides pour développeurs, des références API, de la documentation produit et le workflow derrière chaque exemple.
Navigation dans le portfolio
Parcourez les exemples 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, puis valider les révisions du wiki avec GitHub Desktop.
- 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.
Documentation de recherche d’emploi Sweepy
Sweepy interroge les systèmes de suivi des candidatures et les plateformes d’offres d’emploi, puis classe chaque offre par rapport à un CV. Cet outil Python open source inclut un jeu de documentation de 13 pages. Il couvre l’installation, la configuration du profil et l’export en PDF ou en CSV. Il documente aussi un serveur du Model Context Protocol (MCP) qui lance des balayages depuis un assistant IA.
Premiers pas
- Découvrir Sweepy. Explique le déroulement d’un balayage, les cinq étapes du pipeline et la méthode de notation d’un CV.
- Installer Sweepy. Détaille l’installation de Python, de Git et du dépôt sous Windows, macOS et Linux.
- Lancer votre premier balayage. Montre comment créer un profil, démarrer un balayage et lire la sortie de progression.
Lire les résultats
- Comprendre vos résultats. Décompose l’anatomie des fiches PDF, les pourcentages de compatibilité, les badges de candidature et les colonnes de suivi du CSV.
- CV et scores de compatibilité. Couvre la mise en forme du CV pour l’analyseur et le calcul du score, du CV au pourcentage de compatibilité.
- Lancer Sweepy depuis un assistant IA avec MCP. Connecte le serveur MCP intégré à Antigravity, Claude Desktop ou VS Code.
L’index de la documentation Sweepy rassemble les pages de référence. Il couvre les commandes, les clés de configuration, les notes pour développeurs et la référence des outils. Il recense aussi les sources d’offres d’emploi et les plateformes prises en charge.
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 qui suit 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 - Observabilité parallèle pour le cloud et l'IA. Guide architectural comparant les modèles de routage des journaux pour les systèmes d'entreprise.
- Le SuiClient. Explique comment les clients RPC distribués acheminent 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 et message de commit d'un projet open source qui résolvent des 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
- Concevoir Artie, un assistant de documentation IA. 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 sources Markdown brutes de ces documents, parcourez 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
- Rédaction de documentation produit pour un outil en ligne de commande et son serveur MCP, au plus près du code livré
- 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. Fournit l'environnement d'édition 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 de pipelines de données.
- Python et MCP. Font tourner le moteur de balayage Sweepy et le serveur d’outils qui le relie aux assistants IA.
- DeepL et Lara. Automatisent la traduction de documentation vers d'autres langues.
Chaque page possède un fichier Markdown ou MDX dans le même dépôt. Comparez le rendu avec le texte qui l'a produit.
Chaque exemple suit le même parcours, de la recherche et la rédaction à la vérification sur des sorties réelles, la révision et la publication.