“Lineberty permet à vos clients de prendre un ticket digital et d’éviter une file d’attente physique. Vos clients sélectionnent quand ils souhaitent passer en fonction des disponibilités du lieu équipé de la solution. Une fois leur ticket digital en main, ils peuvent suivre en temps réel leur temps d’attente et seront avertis en cas de retard. Ils profitent tranquillement de leur temps libre au lieu de faire la queue pendant leur temps d’attente. Lineberty les prévient lorsque c’est leur tour en les invitant à passer sans attendre !”
Revue complète de la documentation développeur des APIs Lineberty. Nouvelle CSS conforme aux critères d’accessibilité Web du RGAA. Docusaurus v3.
🔗 La nouvelle documentation de Lineberty.
Projet
J’ai eu pour missions de documenter l’API de Validation puis de mettre à jour le site Web et le Swagger pour documenter le nouvel algorithme.
La mission a aussi eu pour but de migrer la documentation utilisateur (faite avec Hugo, voir ci-dessous) vers Docusaurus v2, la documentation de Lineberty étant appelée à grossir.
Le choix s’est porté vers Docusaurus v2 pour son framework avancé de documentation en ligne qui utilise des fichiers Markdown. Ses points forts sont la navigation, le moteur de recherche, des options de style séduisantes et une personnalisation plutôt facile. Enfin, un plugin ReDoc pour Docusaurus permet d’accéder aux OpenAPIs de Lineberty directement depuis le portail unique de la nouvelle documentation. Une intégration très réussie !
Cette migration vers Docusaurus v2 a été l’occasion d’une revue complète de la documentation, avec une nouvelle page d’accueil et de nouvelles icônes, une nouvelle structure et de nouveaux schémas.
Mots clés de la mission
Docusaurus, REST API, Swagger, Visual Studio Code, Markdown, GitHub, Sourcetree, anglais.
Projet
Il s’agissait de documenter l’API de réservation. Elle permet à des entreprises de créer leur propre application de réservation. Le point commun de ces entreprises est qu’elles ont à gérer des files d’attente. Il peut s’agir de centres commerciaux, grands magasins, parcs d’attractions, sites touristiques, aéroports, etc.
L’application de reservation peut être une application mobile ou accessible sur une borne.
La mission a consisté à :
Documentation de Référence OpenAPI
Le travail a été une combinaison Swagger Editor et template ReDoc.
Documentation utilisateur de l’API Lineberty API
Le travail a été une combinaison pages en Markdown et template Hugo.
Mots clés de la mission
REST API, OpenAPI, Swagger, Visual Studio, Markdown, Draw.io, ReDoc et Hugo, anglais.