Gestion numérique des files d'attente
🏢 Présentation du client
Lineberty est une application SaaS conçue pour révolutionner la gestion des files d’attente grâce à des solutions numériques.
En proposant une suite d’API REST — notamment Booking, Validation et Display — Lineberty permet aux entreprises d’intégrer la gestion de file d’attente virtuelle directement dans leurs applications mobiles, plateformes web ou bornes sur site.
Les clients peuvent réserver des créneaux horaires, suivre les temps d’attente en temps réel et recevoir des notifications lorsque c’est leur tour — transformant ainsi l’attente en temps libre et améliorant l’efficacité opérationnelle.
📇 Éléments clés
Catégorie | Données |
---|---|
Client | Lineberty |
Années du projet | 2019, 2020, 2022, 2023 |
Langue | Anglais |
Outils et frameworks | - Docusaurus 2.x → 3.x - Hugo - ReDoc |
Approche | Méthodologie docs-as-code |
Expertise | Documentation d’API (API REST) |
Mode de collaboration | Collaboration directe (sans intermédiaire) |
🧩 Présentation du projet
Audit initial de l’API & documentation
2019-2020
L’API Booking permet aux organisations — telles que les centres commerciaux, parcs d’attractions, aéroports et sites touristiques — de créer des interfaces de réservation personnalisées pour les applications mobiles ou les bornes sur site.
En tant que consultante et rédactrice technique spécialisée dans la documentation d’API et les workflows docs-as-code :
- J’ai recommandé la publication du guide utilisateur et de la référence API via un site de documentation structuré.
- J’ai mis en place un site statique basé sur Hugo, combinant Markdown pour le contenu et YAML pour la configuration.
- Pour optimiser l’expérience développeur, j’ai utilisé le plugin ReDoc pour afficher la spécification OpenAPI, offrant une interface supérieure à celle par défaut de Swagger UI.
- J’ai collecté les sources, rédigé une documentation claire et accessible en anglais, et créé des schémas explicatifs pour faciliter la compréhension.
Une nouvelle API à documenter
2022
J’ai documenté l’API Validation en réalisant une analyse approfondie de la spécification Swagger et en rédigeant la documentation utilisateur en anglais.
En tant que consultante axée sur l’expérience utilisateur, les standards techniques et la scalabilité, j’ai recommandé la migration de la documentation de Hugo vers Docusaurus v2 — un framework moderne basé sur React, idéal pour un contenu structuré et adapté aux développeurs.
Les principaux avantages incluaient une navigation et une recherche améliorées, un style flexible et personnalisable, des mises à jour continues, et une intégration fluide des OpenAPI de Lineberty via le plugin ReDocusaurus.
Cette migration a permis une refonte complète de la documentation : j’ai restructuré le contenu, repensé la page d’accueil, introduit de nouveaux éléments visuels et amélioré l’ergonomie avec des schémas et icônes clairs.
Revue complète
2023
Revue complète de la documentation développeur de Lineberty.
- Passage à Docusaurus v3.
- Amélioration du design et de l’accessibilité, avec une feuille de style CSS conforme aux critères d’accessibilité web RGAA français.
- Revue complète du contenu, avec de nouveaux schémas.
👩💻 Mon rôle
Collaborer avec Lineberty m’a permis de mettre à profit mes compétences en documentation d’API et mon expérience docs-as-code dans un environnement collaboratif orienté développeurs.
- J’ai dirigé la refonte de la documentation d'API en utilisant les modèles Swagger et ReDoc.
- J’ai migré la documentation existante de Word vers Hugo puis Docusaurus, en améliorant continuellement la navigation et l’accessibilité.
- J’ai mis en œuvre une feuille de style CSS conforme au RGAA pour une meilleure expérience utilisateur.
- J’ai réalisé des audits et rédigé du contenu technique en anglais, adapté aux besoins des développeurs.
🛰️ Technologies & outils
Docusaurus, Hugo, API REST, Swagger, ReDoc, Visual Studio Code, Markdown, Draw.io, GitHub, Sourcetree, Anglais.