Diese Seite enthält die Details eines Projekts für technisches Schreiben, das für die Google-Staffel von Google Docs akzeptiert wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- Open Food Facts
- Technischer Redakteur:
- FutureOfDocs
- Projektname:
- Open Food Facts API dokumentieren
- Projektdauer:
- Lange Ausführung (5 Monate)
Projektbeschreibung
Ich habe zum ersten Mal über eine E-Mail vom Kursleiter eines Kurses zur REST API-Dokumentation gehört, den ich vor einigen Monaten erstellt habe. Obwohl mir die Idee wirklich gefallen hat, beschloss ich, mich nur für ein Projekt zu bewerben, wenn ich mich wirklich damit identifizieren konnte. Das war etwas, das ich neben meinem regulären Job machen würde, und wenn ich es tue, muss es Spaß machen und bedeutungsvoll sein.
Als ich die Beschreibung von Open Food Facts las, wusste ich, dass ich das Projekt gefunden hatte. Ich kümmere mich gerne um Training und Ernährung, um mich um meinen Körper und meine Gesundheit zu kümmern. Ich denke wirklich, dass die Ernährung einer der Schlüssel zu einem glücklichen Leben ist. Wir alle sollten bessere Entscheidungen treffen können. Und das ist nur möglich, wenn wir genügend Informationen über die Lebensmittel und Kosmetika haben, die wir verwenden. Open Food Facts stellt uns diese Informationen zur Verfügung und ich möchte zu dieser fantastischen Initiative beitragen.
In den letzten drei Jahren war ich als technische Redakteurin bei einem Softwareentwicklungsunternehmen tätig, das sich auf Prozess- und Releaseautomatisierung spezialisiert hat. Unter anderem haben wir mit Swagger eine REST API implementiert, die es Entwicklern ermöglicht, über API-Anfragen mit unseren Anwendungen zu kommunizieren. Ich habe den Entwicklungsteams dabei geholfen, bessere Beschreibungen für die Anfragen/Antworten zu verfassen. Gemeinsam haben wir herausgefunden, welche Informationen von unseren Kunden benötigt werden, um sie klar und prägnant zur Verfügung zu stellen.
Ich habe mir die aktuelle Open Food Facts API-Website angesehen und denke, dass wir die Dokumentation umstrukturieren und verbessern können, um sie nutzerfreundlicher zu gestalten (allgemeine, LESE-, SCHREIBENDE Seiten). Darüber hinaus würde ich gerne zusammen mit den Entwicklungsteams eine Möglichkeit erarbeiten, die API-Dokumentation automatisch aus dem Code zu generieren (das braucht Zeit, deswegen schlage ich eine langfristige Zusammenarbeit vor).
Wir alle wissen, dass Looks wichtig sind. Aus diesem Grund können wir auch das CSS und das Logo der REST API anpassen, um die coole Benutzeroberfläche an die Benutzerdokumentation anzupassen.
Ich freue mich auf die Zusammenarbeit mit Ihnen an diesem Projekt!