Lineberty
Rédactrice Technique Senior Freelance — Documentation d'API et portail documentaire
Éléments clés
| Catégorie | Données |
|---|---|
| Organisation | Lineberty |
| Période | Missions récurrentes de février 2019 à décembre 2023 |
| Domaine | Gestion numérique des files d'attente, prise de rendez-vous, validation de tickets et gestion des flux clients |
| Rôle | Rédactrice technique senior freelance |
| Périmètre | Documentation API, revue OpenAPI, contenus développeur, architecture de l'information, migration, design et accessibilité |
| Publics | Développeurs, intégrateurs, partenaires et équipes techniques clientes |
| Langue | Anglais |
| Environnement | OpenAPI, Swagger, ReDoc, Hugo, Docusaurus, Redocusaurus, Markdown, GitHub et CI/CD |
Présentation du projet
Lineberty propose des solutions de gestion numérique des files d'attente permettant aux organisations d'offrir des services de file virtuelle, de prise de rendez-vous, de validation de tickets et d'information en temps réel par l'intermédiaire d'applications mobiles, de sites Web et de dispositifs sur site.
Dans le cadre de plusieurs missions de conseil récurrentes, j'ai créé, enrichi et modernisé la documentation développeur en anglais des API REST Booking, Validation et Display de Lineberty.
La collaboration a évolué d'un audit initial de la documentation API et d'un site Hugo vers un portail développeur Docusaurus plus complet, intégrant les références OpenAPI, des contenus conceptuels, des workflows, des schémas et des améliorations d'accessibilité.
Contexte
La référence API était initialement intégrée aux fichiers OpenAPI, mais les développeurs avaient également besoin de contenus explicatifs pour comprendre comment les différentes API, ressources, statuts et workflows fonctionnaient ensemble.
Le défi ne se limitait donc pas à améliorer la description des endpoints. Il s'agissait de créer une expérience développeur complète associant documentation de référence, concepts, architecture, flux de processus, conseils de mise en œuvre et explications visuelles.
Les missions s'étant déroulées sur plusieurs années, la documentation devait également évoluer avec les nouvelles API, les changements produit, les montées de version des frameworks et les attentes croissantes en matière de navigation, de design, de maintenabilité et d'accessibilité.
Principaux livrables
Documentation API et contenus développeur
J'ai revu et enrichi la documentation OpenAPI des API Booking, Validation et Display de Lineberty.
Ce travail comprenait notamment :
- la clarification des descriptions d'endpoints, des paramètres, des réponses et des statuts ;
- l'identification des incohérences ou explications manquantes dans les spécifications ;
- la rédaction de contenus orientés utilisateurs autour des références API ;
- l'explication des concepts clés et des workflows fonctionnels ;
- la création de schémas d'architecture et de représentations visuelles des processus ;
- l'organisation des contenus autour des besoins concrets des développeurs plutôt que de la seule exposition de la spécification API.
La documentation aidait les développeurs à comprendre non seulement le rôle de chaque endpoint, mais aussi la manière dont les API interagissaient dans des scénarios complets de réservation, de validation et d'affichage de tickets.
Modernisation du portail développeur
J'ai initialement mis en œuvre le site de documentation avec Hugo pour les contenus rédigés et ReDoc pour la référence OpenAPI.
Lorsque la documentation s'est enrichie, j'ai recommandé de migrer le portail vers Docusaurus afin de proposer une expérience développeur plus intégrée et plus évolutive. La migration a inclus une restructuration complète des contenus, une refonte de la page d'accueil, une navigation plus claire, de nouveaux éléments visuels et l'intégration des spécifications OpenAPI avec Redocusaurus.
Lors de la phase finale de révision, j'ai migré le portail vers Docusaurus 3, revu l'ensemble des contenus, créé des schémas supplémentaires et amélioré le design et l'accessibilité, notamment grâce à un travail CSS aligné sur les critères français du RGAA.
Cette modernisation progressive a permis à la plateforme documentaire d'évoluer d'un simple site statique vers un portail développeur structuré et maintenable.
Mon rôle
J'ai piloté la documentation au cours de plusieurs phases successives, en combinant analyse d'API, rédaction technique, architecture de l'information, explication visuelle, choix des frameworks, migration et amélioration de l'accessibilité.
Le caractère récurrent de la collaboration m'a demandé de réévaluer rapidement la documentation à chaque étape, d'intégrer les évolutions produit et API, et de préserver la cohérence entre les guides rédigés et les contenus de référence générés.
Technologies et outils
OpenAPI, Swagger, API REST, ReDoc, Redocusaurus, Hugo, Docusaurus, Markdown, GitHub, Git, Sourcetree, Visual Studio Code, Draw.io, HTML, CSS et JavaScript.
Documentation publique
La documentation développeur de Lineberty est accessible publiquement.
© Florence Venisse, Experte en Documentation Technique & IA – Version révisée le 21/07/2026.