01Projet professionnel
Altme Documentation
Création, structuration et maintenance de la documentation technique d'Altme Wallet Provider, d'abord avec GitBook puis avec Docusaurus, pour rendre l'intégration plus claire et plus autonome.
Documentation technique structurée et maintenue en versions GitBook et Docusaurus pour guider l’onboarding et l’intégration d’Altme Wallet Provider.
Altme Documentation
Contexte du projet
Création et maintenance de la documentation technique complète pour Altme Wallet Provider, un produit dont l'intégration demande de comprendre les concepts wallet, credentials et les différentes étapes d'un parcours développeur. La documentation sert de point d'entrée avant l'installation, l'appel d'API ou la lecture des exemples.
Deux versions ont été travaillées : une première base publiée avec GitBook, puis une version moderne avec Docusaurus. La migration permet de conserver le contenu utile tout en disposant d'une structure plus facile à maintenir et à faire évoluer.
Ma contribution
J'ai structuré les contenus, rédigé et maintenu les pages en Markdown, organisé les parcours d'intégration et participé à la migration de GitBook vers Docusaurus. J'ai également travaillé sur les éléments React/TypeScript qui encadrent la présentation de la documentation.
Le périmètre inclut les références API, les guides étape par étape, les exemples de code, la navigation, la recherche et les pages destinées à une audience internationale.
Pages et sections de documentation migrées ou maintenues entre GitBook et Docusaurus, avec contrôle de la cohérence des parcours.
Technologies utilisées
Base initiale de publication et de partage
Version structurée, extensible et maintenable
Contenu versionnable, réutilisable et lisible
Composants et personnalisation de l'interface
Fonctionnalités principales
- API complète - Documentation exhaustive de l'API Wallet Provider
- Guides d'intégration - Tutoriels étape par étape pour développeurs
- Code interactif - Exemples de code testables en direct
- Recherche - Recherche plein texte dans la documentation
- Multilingue - Support EN/FR pour audience internationale
- Responsive design - Accessible sur tous les appareils
Organisation des parcours
La documentation est organisée pour répondre aux questions dans l'ordre où elles se posent : découvrir le produit, comprendre les concepts, suivre un guide d'intégration puis retrouver une référence précise. Les exemples et les liens entre sections évitent de laisser le lecteur seul face à une liste d'API.
- Découverte — Présenter le rôle de Wallet Provider et les notions nécessaires avant de coder.
- Intégration — Guider le développeur étape par étape avec des exemples directement exploitables.
- Référence — Retrouver rapidement les endpoints, paramètres et comportements documentés.
- Maintenance — Conserver une base organisée lors du passage de GitBook à Docusaurus.
Versions disponibles
Valeur apportée
Le principal gain est un parcours d'onboarding plus lisible : un développeur peut passer du contexte général aux guides puis à la référence API sans changer de logique de lecture. La séparation entre contenu Markdown, composants d'interface et navigation rend aussi les mises à jour plus prévisibles pour l'équipe.
La migration vers Docusaurus fournit une base plus structurée pour faire évoluer la documentation. Elle ne remplace pas la validation produit : les informations publiées doivent continuer à être relues et synchronisées avec les versions réellement disponibles.
Résultats
Documentation structurée pour accompagner la découverte, l'intégration et la recherche d'informations sur Altme Wallet Provider.
Migration de GitBook vers Docusaurus pour proposer une navigation plus structurée, une maintenance plus claire et une base extensible.
Basé à Reims, j’interviens à distance avec des équipes partout en France.