Ta strona zawiera szczegółowe informacje na temat projektu technicznego przyjęta do programu Sezon Dokumentów Google.
Podsumowanie projektu
- Organizacja open source:
- Otwórz informacje o żywności
- Pisarz techniczny:
- FutureOfDocs
- Nazwa projektu:
- Dokumentowanie interfejsu Open Food Facts API
- Długość projektu:
- Długotrwałe (5 miesięcy)
Opis projektu
O „Sezonie Dokumentów” usłyszałam po raz pierwszy w e-mailu od instruktora, który uczestniczył w kursie poświęconym dokumentacji API REST, którą przygotowałam kilka miesięcy temu. Pomysł bardzo mi się podobał, ale zgłosiłam się do projektu tylko wtedy, gdy mogę się z nim identyfikować. To było coś, co robię oprócz swojej zwykłej pracy. Jeśli się tym zajmuję, musi to być przyjemne i wartościowe.
Gdy przeczytałem opis Open Food Facts, wiedziałem, że znam ten projekt. Uwielbiam zadbać o swoje ciało i zdrowie przez ćwiczenia i jedzenie. Uważam, że odżywianie jest jednym z kluczy do szczęśliwego życia. Wszyscy powinniśmy mieć możliwość dokonywania lepszych wyborów, co jest możliwe tylko wtedy, gdy mamy wystarczającą ilość informacji o używanych przez nas żywnościach i kosmetykach. Na stronie Open Food Facts mamy dostęp do tych informacji – chcę wziąć udział w tej niesamowitej inicjatywie.
W ciągu ostatnich 3 lat pracuję jako redaktor ds. technicznych w firmie tworzącej oprogramowanie, która specjalizuje się w automatyzacji procesów i wersji. Między innymi wdrożyliśmy interfejs Swagger API typu REST, który umożliwia programistom komunikowanie się z naszymi aplikacjami za pomocą żądań do interfejsu API. Pomagam zespołom programistów tworzyć lepsze opisy żądań i odpowiedzi. Wspólnie ustaliliśmy, jakich informacji potrzebują nasi klienci, aby przekazywać je w czytelny i zwięzły sposób.
Po zapoznaniu się z obecną witryną interfejsu Open Food Facts API uważam, że możemy przeorganizować i ulepszyć dokumentację, aby była bardziej przyjazna dla użytkownika (strony ogólne, odczyt, zapisy). Poza tym chcielibyśmy razem z zespołami programistów opracować sposób automatycznego generowania dokumentacji interfejsu API z kodu (jest to czasochłonne, dlatego proponuję długotrwałą współpracę).
Wszyscy wiemy, że wygląd jest ważny ;) Dlatego możemy również dostosować styl CSS i logo interfejsu API REST, aby ujednolicić jego wygląd z dokumentacją użytkownika.
Cieszę się, że będziemy mogli pracować nad tym projektem.