Ta strona zawiera szczegółowe informacje na temat projektu dotyczącego pisania technicznego zaakceptowanego do udziału w sezonie Dokumentów Google.
Podsumowanie projektu
- Organizacja open source:
- Otwórz Informacje o żywności
- Pisarz techniczny:
- FutureOfDocs
- Nazwa projektu:
- Dokumentacja interfejsu Open Food Facts API
- Długość projektu:
- Długotrwałe (5 miesięcy)
Opis projektu
Pierwszy raz usłyszałem o „sezonie dokumentów” z e-maila otrzymanego od instruktora na kursie dokumentacji API REST, który przygotowałem kilka miesięcy temu. Chociaż pomysł bardzo mi się podobał, zgłosiłem się do projektu tylko wtedy, gdy mogę się z nim identyfikować. To było coś, co mógłbym robić oprócz swojej zwykłej pracy. Jeśli to robię, to musi być dla mnie świetna zabawa.
Gdy przeczytałem opis Open Food Facts, od razu wiedziałem, że znam ten projekt. Uwielbiam dbać o swoje ciało i zdrowie przez ćwiczenia i jedzenie. Uważam, że odżywianie to klucz do szczęśliwego życia i wszyscy powinniśmy mieć możliwość dokonywania lepszych wyborów, co jest możliwe tylko wtedy, gdy mamy wystarczającą ilość informacji na temat używanych przez nas produktów spożywczych i kosmetyków. Platforma Open Food Facts udostępnia te informacje, dlatego chcę wesprzeć tę niesamowitą inicjatywę.
Przez ostatnie 3 lata pracowałem jako autor techniczny w firmie tworzącej oprogramowanie, która specjalizuje się w automatyzacji procesów i wersji. Zaimplementowaliśmy m.in. 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 pisać lepsze opisy żądań i odpowiedzi. Razem określiliśmy, jakich informacji potrzebują nasi klienci, aby przekazywać je w jasny i zwięzły sposób.
Po przejrzeniu obecnej witryny interfejsu Open Food Facts API myślę, że możemy zmienić strukturę dokumentacji i ulepszyć ją w taki sposób, aby była bardziej przyjazna dla użytkownika (strony ogólne, ODCZYT, ZAPISYWANIE). Co więcej, chcę wspólnie z zespołami programistycznymi opracować sposób automatycznego generowania dokumentacji interfejsu API z kodu (wymaga to czasu, dlatego proponuję długofalową współpracę).
Wszyscy wiemy, że wygląd jest ważny ;) Dlatego możemy też dostosować styl CSS i logo interfejsu API REST, aby ujednolicić interfejs z dokumentacją użytkownika.
Cieszę się, że będziemy mogli pracować nad tym projektem.