Cette page contient les détails d'un projet de rédaction technique accepté pour la Google Season of Docs.
Résumé du projet
- Organisation Open Source:
- Ouvrir Food Facts
- Rédacteur technique:
- FutureOfDocs
- Nom du projet:
- Documenter l'API Open Food Facts
- Durée du projet:
- Longue durée (5 mois)
Project description
J'ai entendu parler de la "Season of Docs" pour la première fois dans un e-mail que j'ai reçu de l'instructeur d'un cours sur la documentation des API REST que j'ai suivi il y a quelques mois. Bien que j'ai beaucoup aimé l'idée, j'ai décidé de ne postuler à un projet que si je pouvais vraiment m'y identifier. C'était quelque chose que je ferais en plus de mon travail habituel, et si je le faisais, cela devait être amusant et avoir du sens.
Lorsque j'ai lu la description d'Open Food Facts, j'ai su que j'avais trouvé ce projet. J'aime prendre soin de mon corps et de ma santé grâce à l'exercice et à l'alimentation. Je pense vraiment que la nutrition est l'une des clés d'une vie heureuse, et nous devrions tous pouvoir faire de meilleurs choix, ce qui n'est possible que si nous avons suffisamment d'informations sur les aliments et les cosmétiques que nous utilisons. Open Food Facts met ces informations à notre disposition, et je souhaite contribuer à cette initiative extraordinaire.
Depuis trois ans, je travaille en tant que rédactrice technique dans une entreprise de développement logiciel spécialisée dans l'automatisation des processus et des versions. Parmi d'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 requêtes/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 "General", "READ" et "WRITE"). De plus, 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 à long terme).
Nous savons tous que l'apparence est importante. C'est pourquoi nous pouvons également modifier le CSS et le logo de l'API REST pour aligner l'UI Swagger sur la documentation utilisateur.
J'ai hâte de travailler avec vous sur ce projet !