Organisationsvorschlag erstellen

Aktuelle Phase:
Ankündigung der Ergebnisse Zeitplan.

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

PROPOSAL TITLE – Name der Organisation

Der Titel Ihres Angebots sollte kurz und spezifisch sein. "Beitragender-Leitfaden für ORGNAME aktualisieren" ist ein guter Angebotstitel. „Verbesserung der Dokumentation“ ist zu vage. „Abschnitte 5, 7, 23 und 99 des Contributor-Leitfadens aktualisieren, FAQs erstellen und Styleguide erstellen“ ist zu lang.

Über Ihre Organisation

Beschreiben Sie in diesem Abschnitt in einigen kurzen Absätzen etwas über Ihre Organisation oder Ihr Projekt. Welches Problem wird durch Ihr Projekt gelöst? Wer sind Ihre Nutzer und Mitwirkenden? Wie lange gibt es Ihre Organisation oder Ihr Projekt schon? Gib etwas Kontext an, damit wir verstehen, warum die Finanzierung deines Vorschlags positive Auswirkungen 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 aus Salz, Zucker, Essig und Gewürzen für jedes mögliche eingelegte Gemüse, von einer einzelnen Gurkenbaby bis hin zu Radieschen in Containerschiffen. Unsere Mitwirkenden sind begeisterte Gurken aus der ganzen Welt, unsere Nutzer sind Hobbyköche, Restaurantköche und Mitarbeiter der Logistik für große Lebensmittelverarbeitungsunternehmen und -organisationen. Unser größter Nutzer ist eine Organisation, die Tafeln hilft, haltbares Gemüse in stabile Gläser mit Essiggurken zu verwandeln, die hungrige Menschen in vielen Gemeinden ernähren und die Lebensmittelverschwendung reduzieren. Darüber hinaus senden unsere Nutzer uns optionale Messwerte über ihre Verwendung von GloriousPickle, mit dem wir das PickleSet erstellen, ein großes Dataset zum Erstellen neuer Pickle-Rezepte durch maschinelles Lernen.

Informationen zu Ihrem Projekt

Das Problem Ihres Projekts

Beschreiben Sie das Problem, bei dem Ihr Projekt helfen wird. Warum ist es für Ihre Organisation oder Ihr Projekt wichtig, dieses Problem zu lösen?

Die Nutzenden möchten dem Tool GloriousPickle Informationen zu neuen Gewürzen und anderen Zutaten (insbesondere Zutaten aus außereuropäischen Gerichten) hinzufügen. 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 aufgeben. Dabei wird davon ausgegangen, dass die Mitwirkenden bereits mit unserem Pull-Anfrageprozess und GitHub vertraut sind, obwohl viele unserer Nutzer keine professionellen Entwickler sind.

Je mehr Informationen wir über die Zutaten haben, desto nützlicher ist GloriousPickle für alle unsere Nutzer!

Der Umfang Ihres Projekts

Teilen Sie uns mit, welche Dokumentation Ihre Organisation erstellen, aktualisieren oder verbessern wird. Wenn bestimmte Arbeiten absichtlich nicht ausgeführt werden, geben Sie diese Informationen ebenfalls an. Geben Sie eine Zeitschätzung an und geben Sie an, ob Sie bereits freiwillige Helfer und technische Redakteure gefunden haben, die an Ihrem Projekt mitarbeiten sollen.

Das GloriousPickle-Projekt (mit dem Codenamen PicklePlus) wird:

  • Prüfen Sie die vorhandene Dokumentation und erstellen Sie ein Reibungslog der aktuellen Dokumentation für die drei wichtigsten Anwendungsfälle (Hinzufügen einer neuen Zutat, Hinzufügen einer Variantenzutat und Aktualisieren oder Korrigieren von Informationen zu einer Zutat).
  • Nutzen Sie das Reibungsprotokoll als Orientierungshilfe für die Lücken in der Dokumentation und erstellen Sie eine aktualisierte Dokumentation für die wichtigsten Anwendungsfälle.
  • Erstellen Sie einen kurzen Spickzettel, um Beitragende, die neu bei Pull-Anfragen sind, und GitHub zu unterstützen, damit sie unseren Prozess besser nutzen können.
  • Berücksichtigen Sie das Feedback von Dokumentationstestern (Freiwillige im Projekt) und der breiteren GloriousPickle-Community.
  • Arbeiten Sie mit dem Release-Team zusammen, um die Dokumentation auf der GloriousPickle-Website zu aktualisieren und einen Prozess zu entwickeln, um die Dokumentation zukünftig mit dem Update-Tool synchron zu halten.

Aufgaben, die für dieses Projekt nicht im Projektumfang enthalten sind:

  • Dieses Projekt wird keinen Prozess für die Vernetzung verschiedener Schreibweisen oder Namen für dieselbe Zutat erstellen.
  • Mit diesem Projekt 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 das technische Schreiben für dieses Projekt, und wir schätzen, dass diese Arbeit bis zu drei Monate in Anspruch nehmen wird. GloriousPickle PickleDocs SIG und @GloriousPicklePat (der Hauptadministrator der API zum Hinzufügen von Zutaten) haben sich verpflichtet, das Projekt zu unterstützen.

Messen des Erfolgs Ihres Projekts

Woher wissen Sie, dass die neue Dokumentation zur Lösung Ihres Problems beigetragen hat? Welche Messwerte werden Sie verwenden und wie werden Sie sie verfolgen?

GloriousPickle erhält durchschnittlich zehn Abrufanfragen pro Quartal, um neue Zutaten hinzuzufügen oder zu aktualisieren (mit dem Tag „Zutat“). Die Mehrheit dieser Pull-Anfragen (> 60%) stammt von früheren Mitwirkenden. Wir sind der Meinung, dass diese verbesserte Dokumentation zu mehr Pull-Anfragen und mehr Pull-Anfragen von neuen Beitragenden führen wird. Da die meisten unserer aktiven Mitwirkenden mit dem Hinzufügen von Zutaten begonnen haben, denken wir auch, dass die Verbesserung dieser Dokumentation insgesamt zu mehr aktiven Beitragenden führen wird.

Wir verfolgen monatlich nach Veröffentlichung der Dokumentation zwei Messwerte (Anzahl der zutatenbezogenen Pull-Anfragen und Anzahl der Pull-Anfragen von neuen Mitwirkenden). Außerdem verfolgen wir die Anzahl der Beitragenden, die insgesamt mehr als drei Beiträge geleistet haben, beginnend vierteljährlich nach Veröffentlichung der Dokumente.

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

  • Die Anzahl der zutatenbezogenen Pull-Anfragen erhöht sich um 20 %.
  • Die Zahl der Pull-Anfragen von neuen Mitwirkenden steigt um 15 %.
  • Die Anzahl der Mitwirkenden, die mehr als 3 Beiträge geleistet haben, steigt um 10% (ab dem Quartal nach Veröffentlichung der Dokumentation).

Zeitplan

Wie lange wird dieser Vorgang voraussichtlich dauern? Können Sie die Aufgaben des Redakteurs nach Monat/Woche aufschlüsseln?

Das Projekt selbst wird etwa sechs Monate dauern. Sobald der Tech Writer eingestellt wurde, werden wir einen Monat mit der Orientierung als Tech Writer verbringen, dann mit dem Audit- und Reibungsprotokoll fortfahren und die letzten Monate damit verbringen, sich auf die Erstellung der Dokumentation zu konzentrieren.

Datum Aktionselemente
Mai Ausrichtung
Juni bis August Vorhandene Dokumentation prüfen und Reibungsprotokolle erstellen
September bis Oktober Dokumentation erstellen
November Projektabschluss

Projektbudget

Allgemeine Richtlinien

  • Sie können Ihr Budget in Ihren Vorschlag oder als separaten Link aufnehmen. Wenn Ihr Budget weniger als zehn Elemente umfasst, empfehlen wir, es in den Vorschlag aufzunehmen.
  • Alle Budgets sollten in US-Dollar angegeben sein. Wir erwarten eine Förderung von 5.000 bis 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 bis 70 %) den technischen Redakteuren zugewiesen wird, die an Ihrem Projekt arbeiten. Wir empfehlen, ein Budget auf Projektbasis festzulegen, wo immer dies möglich ist.
  • Wir gehen davon aus, dass bei Open-Source-Projekten nach Möglichkeit immer Open-Source-Tools zum Einsatz kommen. Wenn dein Projekt absolut finanzielle Mittel für Softwarelizenzen oder Support benötigt, begründe bitte den Betrag.
  • Weitere mögliche Aufwendungen sind:
    • Designarbeit zum Erstellen von Branding, Logos, Vorlagen oder anderen Design-Assets für Ihre Dokumentationswebsite
    • Mindestbeträge (< 200 US-Dollar) für Projektgeschenke (T-Shirts oder Aufkleber für deine Teilnehmer). Wenn Sie das Logo für die Staffel von Google Docs verwenden, muss es das Logo oder den Namen Ihres Projekts oder Ihrer Organisation tragen. Dein Werbegeschenk darf nicht den Namen „Google“ tragen.
    • Minimale Stipendien für Freiwillige, die im Rahmen des Projekts beträchtliche Mentoring- oder Beratungspositionen übernehmen (wir empfehlen nicht mehr als 500 US-Dollar pro Freiwilliger, bitte)
    • Nachgelagerte Spenden für andere Open-Source-Projekte sollten nicht mehr als 10% Ihres Gesamtbudgets betragen.
  • Fügen Sie bei Bedarf weitere Budgetposten sowie eine Begründung für den angeforderten Betrag hinzu. Kostenbegründungen sollten hervorheben, wie die Ausgaben zum Erfolg des gesamten Projekts beitragen.

Beispielbudget

Budgetelement Menge Laufende Summe Anmerkungen/Begründungen
Prüfung, Aktualisierung, Test und Veröffentlichung einer neuen Dokumentation des Prozesses zum Hinzufügen von Zutaten für GloriousPickle 5.000,00 5.000,00
Ehrenamtliche Stipendien 500 6500.00 3 Freiwilligenstipendien x 500 Stipendien
Projekt-T-Shirts (10 T-Shirts) 150.00 6.650,00
Riesiges aufblasbares Einhorn 99.99 6.749,99 Wir geben das aufblasbare Einhorn an das Team, das die Fragen des technischen Redakteurs in der Projektentwicklungsphase am schnellsten beantwortet.
GESAMT 6.749,99

Weitere Informationen

Geben Sie hier zusätzliche Informationen an, die für Ihr Angebot relevant sind.

  • Frühere Erfahrung mit technischen Redakteuren oder Dokumentationen: Wenn Sie oder einer Ihrer Mentoren bereits mit technischen Redakteuren zusammengearbeitet oder eine Dokumentation erstellt haben, geben Sie dies in Ihrer Bewerbung an. Beschreibe, welche Dokumentation du erstellt hast und wie du mit der zuständigen Redaktion zusammengearbeitet hast. Beschreiben Sie beispielsweise, welche Überprüfungsprozesse Sie verwendet haben oder inwiefern die Fähigkeiten des technischen Redakteurs für Ihr Projekt nützlich waren. Erklären Sie, wie Ihnen diese bisherige Erfahrung bei der Zusammenarbeit mit einem technischen Redakteur in „Season of Docs“ helfen kann.

  • Frühere Teilnahme an „Season of Docs“, „Google Summer of Code“ oder anderen Programmen: Wenn du oder einer deiner Mentoren am Google Summer of Code oder einem ähnlichen Programm teilgenommen hast, erwähne dies in deiner Bewerbung. Beschreiben Sie Ihre Erfolge in diesem Programm. Erklären Sie, wie sich diese Erfahrung auf Ihre Arbeit in Season of Docs auswirken kann.