Ta strona zawiera szczegółowe informacje o projekcie polegającym na pisaniu tekstów technicznych, który został zaakceptowany w ramach Google Season of Docs.
Podsumowanie projektu
- Organizacja open source:
- Otwórz Informacje o żywności
- Specjalista ds. technicznych:
- FutureOfDocs
- Nazwa projektu:
- Dokumentacja interfejsu Open Food Facts API
- Długość projektu:
- Długotrwałe (5 miesięcy)
Opis projektu
Po raz pierwszy dowiedziałem się o „Season of Docs” z e-maila od instruktora z kursu dotyczącego dokumentacji interfejsu API REST, który odbyłem kilka miesięcy temu. Chociaż pomysł bardzo mi się podobał, zdecydowałam się zgłosić do projektu tylko wtedy, gdy będę mogła się z nim utożsamić. To było coś, co robiłem oprócz mojej regularnej pracy, a jeśli tak było, to musiało być coś przyjemnego i znacącego.
Gdy przeczytałam opis Open Food Facts, wiedziałam, że to właśnie ten projekt. Lubię dbać o swoje ciało i zdrowie poprzez ćwiczenia i odpowiednie odżywianie. Uważam, że odżywianie się jest jednym z kluczy do szczęśliwego życia, i że wszyscy powinniśmy mieć możliwość dokonywania lepszych wyborów, co jest możliwe tylko wtedy, gdy mamy wystarczającą ilość informacji o żywności i kosmetyki, których używamy. Dzięki Open Food Facts mamy dostęp do tych informacji. Chcę wziąć udział w tej niezwykłej inicjatywie.
Przez ostatnie 3 lata pracowałam jako autorka dokumentacji technicznej w firmie zajmującej się tworzeniem oprogramowania, która specjalizuje się w automatyzacji procesów i wersji. Wdrożyliśmy m.in. interfejs API REST z Swaggerem, który pozwala programistom na komunikowanie się z naszymi aplikacjami za pomocą żądań interfejsu API. Pomogłem zespołom programistów w napisaniu lepszych opisów żądań i odpowiedzi. Razem ustaliliśmy, jakie informacje są potrzebne naszym klientom, aby mogli je przekazywać w sposób przejrzysty i zwięzły.
Sprawdziliśmy obecną stronę API Open Food Facts i uważamy, że możemy ją uporządkować i ulepszyć, aby była bardziej przyjazna użytkownikom (strony General, READ i WRITE). Chcielibyśmy też wspólnie z zespołami programistów skonfigurować sposób automatycznego generowania dokumentacji interfejsu API na podstawie kodu (to zajmuje czas, dlatego proponujemy długotrwałą współpracę).
Wszyscy wiemy, że wygląd jest ważny ;) Dlatego możemy również dostosować CSS i logo interfejsu API REST, aby dostosować interfejs gadżetów do dokumentacji użytkownika.
Z niecierpliwością czekam na współpracę z Tobą przy tym projekcie.