Auf dieser Seite finden Sie die Details zu einem Projekt für technisches Schreiben, das für Google Season of Docs angenommen wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- Food Facts öffnen
- Technischer Redakteur:
- FutureOfDocs
- Projektname:
- Open Food Facts API dokumentieren
- Projektdauer:
- Lang andauernd (5 Monate)
Projektbeschreibung
Ich habe zum ersten Mal von „Season of Docs“ durch eine E-Mail erfahren, die ich vor einigen Monaten vom Dozenten eines Kurses zur REST API-Dokumentation erhalten habe. Obwohl mir die Idee sehr gefiel, beschloss ich, mich nur für ein Projekt zu bewerben, wenn ich mich wirklich damit identifizieren konnte. Das sollte etwas sein, das ich neben meinem normalen Job machen würde, und wenn ich es tun würde, muss es Spaß machen und sinnvoll sein.
Als ich die Beschreibung von Open Food Facts las, wusste ich, dass ich das richtige Projekt gefunden hatte. Ich achte gerne auf meinen Körper und meine Gesundheit durch Bewegung und Ernährung. Ich denke wirklich, dass Ernährung einer der Schlüssel zu einem glücklichen Leben ist und wir alle in der Lage sein sollten, bessere Entscheidungen zu treffen. Das ist nur möglich, wenn uns genügend Informationen zu den Lebensmitteln und Kosmetikprodukten vorliegen, die wir verwenden. Open Food Facts stellt uns diese Informationen zur Verfügung und ich möchte zu dieser tollen Initiative beitragen.
In den letzten drei Jahren habe ich als technischer Redakteur bei einem Softwareentwicklungsunternehmen gearbeitet, das sich auf die Prozess- und Release-Automatisierung spezialisiert hat. Unter anderem haben wir eine REST API mit Swagger implementiert, mit der Entwickler über API-Anfragen mit unseren Anwendungen kommunizieren können. Ich habe den Entwicklungsteams dabei geholfen, bessere Beschreibungen für die Anfragen/Antworten zu verfassen. Gemeinsam haben wir ermittelt, welche Informationen unsere Kunden benötigen, um sie auf klare und prägnante Weise zur Verfügung zu stellen.
Ich habe mir die aktuelle Website der Open Food Facts API angesehen und denke, dass wir die Dokumentation umstrukturieren und verbessern können, um sie nutzerfreundlicher zu gestalten (Seiten mit allgemeinen, Lese- und Schreibberechtigung). Darüber hinaus würde ich gerne gemeinsam mit den Entwicklungsteams eine Möglichkeit schaffen, die API-Dokumentation automatisch aus dem Code zu generieren (das braucht Zeit, deshalb schlage ich eine lange Zusammenarbeit vor).
Wir alle wissen, dass das Aussehen wichtig ist 😉. Deshalb können wir auch das CSS und das Logo der REST API anpassen, um die Swagger-UI an die Nutzerdokumentation anzupassen.
Ich freue mich auf die Zusammenarbeit mit Ihnen an diesem Projekt.