Diese Seite wurde von der Cloud Translation API übersetzt.

Organisationsvorschlag erstellen

Aktuelle Phase:
Projektabschluss. Siehe Zeitachse.

Verwenden Sie diesen Leitfaden als Vorlage, um den Projektvorschlag Ihrer Organisation zu erstellen.

PROPOSAL TITLE - organization name

Der Titel Ihres Vorschlags sollte kurz und prägnant sein. „Update ORGNAME Contributor Guide“ ist ein guter Vorschlag für einen Titel. „Verbesserungen an der Dokumentation“ ist zu ungenau. „Abschnitte 5, 7, 23 und 99 des Leitfadens für Mitwirkende, FAQs erstellen und Styleguide erstellen aktualisieren“ ist zu lang.

Informationen zu Ihrer Organisation

In diesem Abschnitt sollten Sie uns in wenigen kurzen Absätzen Ihre Organisation oder Ihr Projekt vorstellen. Welches Problem löst Ihr Projekt? Wer sind Ihre Nutzer und Mitwirkenden? Wie lange gibt es Ihre Organisation oder Ihr Projekt schon? Geben Sie uns einen Kontext, damit wir nachvollziehen können, warum die Finanzierung Ihres Vorschlags einen positiven Einfluss auf Open Source und die Welt haben würde.

GloriousPickle (aktuelle Version 1.2.3, erste Veröffentlichung 2009) ist eine MIT-lizenzierte Bibliothek, mit der das perfekte Verhältnis von Salz, Zucker, Essig und Gewürzen für jedes Gemüse, das eingelegt werden kann, berechnet werden kann. Die Mengen reichen von einer einzelnen Minigurke bis hin zu Containerladungen Radieschen. Unsere Mitwirkenden sind Gurkenfans aus aller Welt und unsere Nutzer sind Hobbyköche, Restaurantköche und Mitarbeiter in der Logistik großer Lebensmittelverarbeitungsunternehmen und -organisationen. Unser größter Nutzer ist eine Organisation, die Lebensmittelbanken dabei unterstützt, Gemüse mit kurzer Haltbarkeit in haltbare Gläser mit eingelegtem Gemüse umzuwandeln. So werden hungrige Menschen in vielen Gemeinden versorgt und Lebensmittelabfälle reduziert. Außerdem senden uns unsere Nutzer optionale Messwerte zu ihrer Nutzung von GloriousPickle. Diese verwenden wir, um das PickleSet zu erstellen, ein großes Dataset zum Erstellen neuer Gurkenrezepte mithilfe von maschinellem Lernen.

Informationen zu Ihrem Projekt

Das Problem Ihres Projekts

Beschreiben Sie das Problem, das Ihr Projekt lösen soll. Warum ist es für Ihr Unternehmen oder Projekt wichtig, dieses Problem zu lösen?

Die Nutzer möchten dem GloriousPickle-Tool Informationen zu neuen Gewürzen und anderen Zutaten hinzufügen können, insbesondere zu Zutaten aus nichteuropäischen Küchen. Leider ist der Prozess zum Hinzufügen dieser Informationen nicht gut dokumentiert. Das bedeutet, dass potenzielle Mitwirkende ein Problem im Projekt eröffnen müssen, um Hilfe zu erhalten, oder einfach ganz aufgeben. Außerdem wird davon ausgegangen, dass Mitwirkende bereits mit unserem Pull-Request-Verfahren und GitHub vertraut sind, obwohl viele unserer Nutzer keine professionellen Entwickler sind.

Je mehr Informationen zu den Zutaten wir haben, desto nützlicher ist GloriousPickle für alle unsere Nutzer.

den Umfang Ihres Projekts

Teilen Sie uns mit, welche Dokumentation Ihre Organisation erstellen, aktualisieren oder verbessern wird. Wenn bestimmte Arbeiten bewusst nicht ausgeführt werden, geben Sie dies ebenfalls an. Geben Sie eine Zeitschätzung an und ob Sie bereits freiwillige Helfer und einen technischen Redakteur für Ihr Projekt gefunden haben.

Das GloriousPickle-Projekt (Codename PicklePlus) wird:

Prüfen Sie die vorhandene Dokumentation und erstellen Sie ein Protokoll der aktuellen Dokumentation für die drei wichtigsten Anwendungsfälle: Hinzufügen einer neuen Zutat, Hinzufügen einer Variante einer Zutat und Aktualisieren oder Korrigieren von Informationen zu einer Zutat.
Verwenden Sie das Reibungsprotokoll als Leitfaden, um die Lücken in der Dokumentation zu verstehen, und erstellen Sie eine aktualisierte Dokumentation für die wichtigsten Anwendungsfälle.
Erstellen Sie eine kurze „Kurzanleitung“, die Mitwirkenden, die neu mit Pull-Anfragen und GitHub vertraut sind, dabei hilft, unseren Prozess zu nutzen.
Feedback von Dokumentationstestern (freiwillige Helfer im Projekt) und der gesamten GloriousPickle-Community einbeziehen.
Arbeiten Sie mit dem Release-Team zusammen, um die Dokumentation auf der GloriousPickle-Website zu aktualisieren und einen Prozess zu erstellen, mit dem die Dokumentation in Zukunft mit dem Update-Tool synchronisiert wird.

Arbeiten, die nicht in den Aufgabenbereich dieses Projekts fallen:

Mit diesem Projekt wird kein Prozess für die Verknüpfung verschiedener Schreibweisen oder Namen für dieselbe Zutat erstellt.
Für dieses Projekt werden keine GitHub-Anleitungen erstellt. Stattdessen enthält die Cheatsheet Links zu relevanten und hilfreichen Materialien.

Wir haben zwei gute Kandidaten für die technische Dokumentation für dieses Projekt und schätzen, dass die Arbeit drei Monate dauern wird. Die GloriousPickle PickleDocs SIG und @GloriousPicklePat (der Hauptwart der API zum Hinzufügen von Zutaten) haben sich bereit erklärt, das Projekt zu unterstützen.

Erfolg des Projekts messen

Woher wissen Sie, dass Ihre neue Dokumentation dazu beigetragen hat, das Problem zu lösen? Welche Messwerte verwenden Sie und wie erfassen Sie sie?

GloriousPickle erhält durchschnittlich zehn Pull-Anfragen pro Quartal, um neue Zutaten hinzuzufügen oder zu aktualisieren (mit dem Tag „Zutat“). Der Großteil dieser Pull-Anfragen (über 60%) stammt von früheren Mitwirkenden. Wir sind davon überzeugt, dass diese verbesserte Dokumentation zu mehr Pull-Requests und mehr Pull-Requests von neuen Mitwirkenden führen wird. Da die meisten unserer aktiven Mitwirkenden damit begonnen haben, Zutaten hinzuzufügen, gehen wir davon aus, dass die Verbesserung dieser Dokumentation insgesamt zu mehr aktiven Mitwirkenden führen wird.

Nach der Veröffentlichung der Dokumentation werden wir monatlich zwei Messwerte erfassen: die Anzahl der Pull-Requests zu Inhaltsstoffen und die Anzahl der Pull-Requests von neuen Mitwirkenden. Wir werden auch die Anzahl der Mitwirkenden erfassen, die insgesamt mehr als drei Beiträge geleistet haben. Diese Erfassung erfolgt ab der Veröffentlichung der Dokumentation vierteljährlich.

Wir würden das Projekt als erfolgreich betrachten, wenn nach der Veröffentlichung der neuen Dokumentation Folgendes zutrifft:

Die Anzahl der Pull-Anfragen zu Zutaten steigt um 20%
Die Anzahl der Pull-Requests von neuen Mitwirkenden steigt um 15 %.
Die Anzahl der Mitwirkenden, die mehr als drei Beiträge geleistet haben, steigt um 10 % (Beginn des Quartals nach Veröffentlichung der Dokumentation)

Zeitachse

Wie lange wird diese Arbeit Ihrer Meinung nach dauern? Können Sie die Aufgaben der technischen Redakteure nach Monat oder Woche aufschlüsseln?

Das Projekt selbst wird etwa sechs Monate dauern. Sobald der Technische Redakteur eingestellt ist, verbringen wir einen Monat mit der Einarbeitung des Technischen Redakteurs, gehen dann zur Analyse und zum Friction-Log über und konzentrieren uns in den letzten Monaten auf die Erstellung der Dokumentation.

Daten	Aktionselemente
Mai	Ausrichtung
Juni bis August	Vorhandene Dokumentation prüfen und ein Reibungsprotokoll erstellen
September bis Oktober	Dokumentation erstellen
November	Projektabschluss

Projektbudget

Allgemeine Richtlinien

Sie können Ihr Budget in Ihr Angebot aufnehmen oder einen separaten Link dafür angeben. Wenn Ihr Budget weniger als zehn Elemente umfasst, empfehlen wir, es in Ihr Angebot aufzunehmen.
Alle Budgets müssen in US-Dollar angegeben sein. Wir gehen davon aus, dass die Zuschüsse zwischen 5.000 und 15.000 $ liegen. Wenn Ihr Projekt außerhalb dieses Bereichs liegt, müssen Sie zusätzliche Informationen zur Begründung Ihres Budgets angeben.
Wir gehen davon aus, dass der Großteil Ihres Budgets (mindestens 60–70 %) für den technischen Redakteur vorgesehen ist, der an Ihrem Projekt arbeitet. Wir empfehlen, nach Möglichkeit ein Budget pro Projekt festzulegen.
Wir erwarten, dass Open-Source-Projekte nach Möglichkeit Open-Source-Tools verwenden. Wenn für Ihr Projekt unbedingt Mittel für proprietäre Softwarelizenzen oder Support erforderlich sind, begründen Sie die Höhe.
Weitere mögliche Ausgaben:
- Designarbeiten zum Erstellen von Branding, Logos, Vorlagen oder anderen Design-Assets für Ihre Dokumentationswebsite
- Minimalbeträge (unter 200 $) für Projekt-Swag (T-Shirts oder Sticker für Ihre Teilnehmer) Wenn Sie das Google Season of Docs-Logo verwenden, muss es mit dem Logo oder Namen Ihres Projekts oder Ihrer Organisation kombiniert werden. Der Name Google darf nicht auf Ihren Werbeartikeln verwendet werden.
- Minimale Stipendien für Freiwillige, die im Projekt eine wichtige Mentoren- oder Beratungsrolle übernehmen (wir empfehlen maximal 500 $pro Freiwilligem)
- Weitergeleitete Spenden an andere Open-Source-Projekte dürfen maximal 10% Ihres Gesamtbudgets betragen.
Fügen Sie nach Bedarf weitere Budgetposten sowie eine Begründung für den gewünschten Betrag hinzu. In der Begründung der Ausgaben sollte hervorgehoben werden, wie die Ausgaben zum Erfolg des gesamten Projekts beitragen.

Beispielbudget

Budgetposten	Menge	Laufende Summe	Anmerkungen/Begründungen
Technischer Redakteur muss die neue Dokumentation zum Hinzufügen von Zutaten für GloriousPickle prüfen, aktualisieren, testen und veröffentlichen	5.000,00	5.000,00
Stipendien für Freiwillige	500	6.500,00	3 Stipendien für Freiwillige × 500 €
Projekt-T-Shirts (10 T-Shirts)	150,00	6.650,00
Riesiges aufblasbares Einhorn (4,6 m-Version)	99.99	6749.99	Das aufblasbare Einhorn erhält das Team, das während der Projektentwicklung die Fragen des technischen Redakteurs am schnellsten beantwortet.
GESAMT		6749.99

Weitere Informationen

Geben Sie hier alle zusätzlichen Informationen an, die für Ihren Vorschlag relevant sind.

Frühere Erfahrung mit technischen Redakteuren oder Dokumentationen:Wenn Sie oder einer Ihrer Mentoren schon einmal mit technischen Redakteuren zusammengearbeitet oder Dokumentationen erstellt haben, erwähnen Sie dies in Ihrer Bewerbung. Beschreiben Sie die von Ihnen erstellte Dokumentation und die Art und Weise, wie Sie mit dem technischen Redakteur zusammengearbeitet haben. Beschreiben Sie beispielsweise die von Ihnen verwendeten Überprüfungsprozesse oder wie die Fähigkeiten des technischen Redakteurs für Ihr Projekt nützlich waren. Erläutern Sie, wie diese bisherigen Erfahrungen Ihnen bei der Zusammenarbeit mit einer technischen Redakteurin in der Google Season of Docs helfen können.
Frühere Teilnahme an Google Season of Docs, Google Summer of Code oder anderen Programmen:Wenn Sie oder einer Ihrer Mentoren am Google Summer of Code oder einem ähnlichen Programm teilgenommen haben, erwähnen Sie dies in Ihrer Bewerbung. Beschreiben Sie Ihre Leistungen in diesem Programm. Erläutern Sie, wie diese Erfahrung Ihre Arbeit bei Google Season of Docs beeinflussen kann.