Diese Seite enthält die Details zu einem Projekt für technisches Schreiben, das für die Google-Produktsaison von Google Docs akzeptiert wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- Open Food Facts
- Technischer Redakteur:
- FutureOfDocs
- Projektname:
- Open Food Facts API dokumentieren
- Projektdauer:
- Langfristig (5 Monate)
Projektbeschreibung
Ich habe zum ersten Mal durch eine E-Mail vom Kursleiter eines Kurses zur REST API-Dokumentation gehört, die ich vor einigen Monaten bearbeitet habe. Obwohl mir die Idee wirklich gefallen hat, beschloss ich, mich nur für ein Projekt zu bewerben, wenn ich mich wirklich damit identifizieren kann. Das war etwas, das ich neben meinem normalen Job machen würde, und wenn ich es tue, muss es Spaß machen und bedeutsam sein.
Als ich die Beschreibung von Open Food Facts las, wusste ich, dass ich dieses Projekt gefunden hatte. Ich kümmere mich gerne um meinen Körper und meine Gesundheit, indem ich Sport und Ernährung schaffe. Ich glaube 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, was nur möglich ist, wenn wir genügend Informationen über die Lebensmittel und Kosmetikprodukte 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 technischer Redakteur 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 unsere Kunden benötigen, 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 benutzerfreundlicher zu machen (allgemeine, LESE- und SCHREIB-Seiten). Außerdem würde ich gerne zusammen mit den Entwicklungsteams eine Möglichkeit einrichten, die API-Dokumentation automatisch aus dem Code zu generieren (das braucht Zeit, daher schlage ich eine langfristige Zusammenarbeit vor).
Wir alle wissen, dass Looks wichtig sind. Daher können wir auch das REST-API-CSS und -Logo optimieren, um die coolere Benutzeroberfläche an die Nutzerdokumentation anzupassen.
Ich freue mich auf die Zusammenarbeit mit Ihnen an diesem Projekt!