Cette page contient les détails d'un projet de rédaction technique accepté pour Google Season of Docs.
Résumé du projet
- Organisation Open Source:
- Infos alimentaires ouvertes
- Rédacteur technique:
- FutureOfDocs
- Nom du projet:
- Documenter l'API Open Food Facts
- Durée du projet:
- Exécution longue (5 mois)
Project description
J'ai entendu parler de "Season of Docs" via un e-mail que j'ai reçu de la part d'un formateur dans un cours sur la documentation de l'API REST que j'ai suivi il y a quelques mois. Bien que l'idée m'ait beaucoup plu, j'ai décidé de ne postuler à un projet que si je pouvais vraiment m'identifier à celui-ci. C'était quelque chose que je ferais en plus de mon travail habituel, et si je le faisais, ce doit être amusant et significatif.
Lorsque j'ai lu la description d'Open Food Facts, je savais que j'avais trouvé ce projet. J'aime prendre soin de mon corps et de ma santé par le biais de l'exercice physique et de l'alimentation. Je pense vraiment que la nutrition est l'une des clés d'une vie heureuse et que nous devrions tous être en mesure de faire de meilleurs choix, ce qui n'est possible que si nous avons suffisamment d'informations sur la nourriture et les cosmétiques que nous utilisons. Open Food Facts met ces informations à notre disposition, et je veux contribuer à cette incroyable initiative.
Au cours des trois dernières années, j'ai travaillé en tant que rédactrice technique dans une société de développement de logiciels spécialisée dans l'automatisation des processus et des versions. Entre autres, nous avons implémenté une API REST avec Swagger qui permet aux développeurs de communiquer avec nos applications via des requêtes API. J'ai aidé les équipes de développement à rédiger de meilleures descriptions pour les demandes et les réponses. Ensemble, nous avons identifié les informations dont nos clients ont besoin pour les fournir de manière claire et concise.
J'ai examiné le site actuel de l'API Open Food Facts et je pense que nous pouvons restructurer et améliorer la documentation pour la rendre plus conviviale (pages générales, LIRE, ÉCRIRE). Par ailleurs, j'aimerais mettre en place, avec les équipes de développement, un moyen de générer automatiquement la documentation de l'API à partir du code (cela prend du temps, c'est pourquoi je propose une collaboration de longue durée).
Nous savons tous que l'apparence est importante ;) C'est pourquoi nous pouvons aussi modifier le code CSS et le logo de l'API REST pour aligner l'interface utilisateur fantaisiste avec la documentation utilisateur.
Je me réjouis de travailler avec vous sur ce projet.