Organisationsvorschlag erstellen

Aktuelle Phase:
Ergebnisse wurden bekannt gegeben. Siehe Zeitachse.

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

PROPOSAL TITLE – Name der Organisation

Der Titel Ihres Vorschlags sollte kurz und prägnant sein. „Update ORGNAME Contributor Guide“ ist ein guter Titel für einen Vorschlag. „Verbesserungen an der Dokumentation“ ist zu vage und „Abschnitte 5, 7, 23 und 99 des Leitfadens für Mitwirkende aktualisieren, FAQs erstellen und Styleguide erstellen“ 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 im Jahr 2009) ist eine vom MIT lizenzierte Bibliothek zur einfachen Berechnung des perfekten Verhältnisses von Salz, Zucker, Essig und Gewürzen für jedes mögliche eingelegte Gemüse in Mengen von einer einzelnen Babygurke bis hin zu Behältern mit 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 Ernährungsbanken hilft, kurzlebiges Gemüse in stabile Gläser mit eingelegtem Gemüse zu verwandeln, um hungrige Menschen in vielen Gemeinden zu füttern und Lebensmittelverschwendung zu reduzieren. Darüber hinaus senden uns unsere Nutzer optionale Messwerte zu ihrer Verwendung von GloriousPickle, mit denen wir das PickleSet erstellen, ein großes Dataset zum Erstellen neuer Pickle-Rezepte durch maschinelles Lernen.

Ihr Projekt

Das Problem Ihres Projekts

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

Die Nutzenden möchten Informationen über neue Gewürze und andere Zutaten (insbesondere Zutaten aus der außereuropäischen Küche) zum GloriousPickle-Tool hinzufügen können. Leider ist das Hinzufügen dieser Informationen nicht gut dokumentiert. Potenzielle Mitwirkende müssen also ein Problem im Projekt melden, um Hilfe zu erhalten, oder sie geben einfach auf. 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 Mitarbeiter 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.
  • Das Feedback von Testern der Dokumentation (ehrenamtliche Mitarbeiter des Projekts) und der 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 Projektumfang fallen:

  • Im Rahmen dieses Projekts wird kein Prozess für die Vernetzung verschiedener Schreibweisen oder Namen für dieselbe Zutat erstellt.
  • Im Rahmen dieses Projekts werden keine GitHub-Tutorials erstellt. Stattdessen enthält die Übersicht einen Link zu vorhandenem Material, das relevant und hilfreich ist.

Wir haben zwei gute Kandidaten für die technische Dokumentation für dieses Projekt und schätzen, dass die Arbeit drei Monate in Anspruch nehmen 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.

Den Erfolg Ihres 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 Nutzer mit dem Hinzufügen von Zutaten begonnen haben, gehen wir davon aus, dass die Verbesserung dieser Dokumentation auch zu mehr aktiven Nutzern insgesamt 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. Außerdem erfassen wir die Anzahl der Mitwirkenden, die insgesamt mehr als drei Beiträge geleistet haben. Diese werden nach der Veröffentlichung der Dokumentation vierteljährlich erfasst.

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

  • Die Anzahl der inhaltsbezogenen Pull-Anfragen 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 der Veröffentlichung der Dokumentation)

Zeitachse

Wie lange wird diese Arbeit Ihrer Meinung nach dauern? Können Sie die Aufgaben der technischen Redakteure nach Monat/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 Reibungsprotokoll erstellen
September bis Oktober Dokumentation erstellen
November Projektabwicklung

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, sollten Sie es in Ihr Angebot aufnehmen.
  • Alle Budgets müssen in US-Dollar angegeben sein. Wir erwarten Fördergelder zwischen 5.000 US-Dollar und 15.000 US-Dollar. Wenn Ihr Projekt außerhalb dieses Bereichs liegt, geben Sie bitte zusätzliche Informationen an, die Ihr Budget rechtfertigen.
  • 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 eine Budgetierung pro Projekt.
  • 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, geben Sie bitte eine Begründung für den Betrag an.
  • Weitere mögliche Ausgaben:
    • Designarbeiten zum Erstellen von Branding, Logos, Vorlagen oder anderen Design-Assets für Ihre Dokumentationswebsite
    • Mindestbeträ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. Ihr Teilnahmegeschenk darf nicht den Namen „Google“ tragen.
    • Minimale Stipendien für Freiwillige, die im Projekt eine wichtige Mentoren- oder Beratungsrolle übernehmen (wir empfehlen maximal 500 $pro Freiwilligem)
    • Spenden an andere Open-Source-Projekte dürfen maximal 10% Ihres Gesamtbudgets betragen.
  • Fügen Sie bei Bedarf weitere Budgetposten sowie eine Begründung für den angeforderten Betrag hinzu. In der Begründung der Ausgaben sollte hervorgehoben werden, wie die Ausgaben zum Erfolg des gesamten Projekts beitragen.

Beispielbudget

Budgetelement 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 erhalten Sie, wenn Sie die Fragen des technischen Redakteurs während der Projektentwicklung am schnellsten beantworten.
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 alle Überprüfungsprozesse, die Sie verwendet haben, oder inwiefern 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 Erfolge in diesem Programm. Erläutern Sie, wie sich diese Erfahrung auf Ihre Arbeitsweise in der Google-Saison der Docs-Dateien auswirken kann.