Beispiel einer Google-Fallstudie zur Staffel von Google Docs

Aktuelle Phase:
Bekanntgabe der Ergebnisse. Siehe Zeitachse.

Nutzen Sie dieses Beispiel, um Ihren eigenen Fallstudienbericht zu erstellen.

PicklePlus: Das GloriousPickle-Beitragstool dokumentieren

Organisation oder Projekt: Glorious Pickle Link zur Hauptwebsite Ihrer Organisation oder Ihres Projekts

Beschreibung der Organisation: 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 eingelegte Gemüse, von einzelnen einsamen Babyretteln bis hin zu Containerschiffen.

Autoren: optional: Autoren der Fallstudie auflisten; gegebenenfalls Nutzernamen verwenden

Problembeschreibung/Angebotszusammenfassung

Welches Problem wollten Sie mit der neuen oder verbesserten Dokumentation lösen? Verlinke nach Möglichkeit die Angebotsseite auf deiner Projektwebsite.

Das Hinzufügen von Zutaten zur Zutatendatenbank des GloriousPickle-Tools ist zeitaufwändig und kompliziert und das Tool hat keine gute Dokumentation. Viele Personen, die am Programm teilnehmen möchten, haben keine Erfahrung mit Git oder mit Pull-Anfragen. Das bedeutet, dass bei GloriousPickle erhebliche Lücken in unseren Zutatendaten vorhanden sind und unser Tool weniger nützlich ist. Wir hoffen, dass wir durch die Verbesserung der Dokumentation für das Hinzufügen neuer Zutaten neue Beitragende und mehr Einmachung fördern können.

Projektbeschreibung

Angebot erstellen

Wie sind Sie zu Ihrem Vorschlag für die Saisonale von Google Docs gekommen? Welchen Prozess hat Ihre Organisation genutzt, um sich für eine Idee zu entscheiden? Wie haben Sie Feedback eingeholt und berücksichtigt?

GloriousPickle PickleDocs SIG erfuhr über einen Tweet der Google-Niederlassung für Open-Source-Programme vom Google Season of Docs-Programm. Die SIG diskutierte das Programm in ihrer zweiwöchentlichen Sitzung und erklärte sich bereit, einen Vorschlag zu erstellen. Zwei Mitglieder der SIG (@KimChiCook und @Dillicious) haben sich bereit erklärt, an dem Entwurf des Vorschlags mitzuarbeiten, der bei der nächsten Sitzung überprüft werden sollte.

Nachdem die PickleDocs SIG dem Angebotsentwurf zugestimmt hatte, wurde eine E-Mail an das Projekt gesendet, in der sie um Feedback gebeten wurden. 14 Community-Mitglieder gaben Feedback, darunter @GloriousPicklePat, der Administrator der API zum Hinzufügen von Inhaltsstoffen. @GloriousPicklePat hat sich freiwillig als Mitarbeiter des Programms gemeldet.

Nachdem das erhaltene Feedback diskutiert und umgesetzt wurde, wurde der Vorschlag zur Abstimmung an das GloriousPickle Project Lenking Committee gesendet. Alle fünf Mitglieder der GPPSC haben mit +1 für die Einreichung des Vorschlags und der Bewerbung gestimmt, und @VinegarViv erklärte sich bereit, beim Erstellen des Open Collective-Kontos zu helfen, das für die Teilnahme am Programm und die Überwachung von Zahlungen erforderlich ist.

Budget

Fügen Sie Ihrem Budget einen kurzen Abschnitt hinzu. Wie haben Sie die Arbeit geschätzt? Gab es unerwartete Ausgaben? Haben Sie am Ende weniger als die Fördergelder ausgegeben? Haben Sie die Mittel richtig zugewiesen oder haben Sie bei einigen Posten mehr/weniger/unnötig ein Budget zugewiesen? Hatten Sie neben Google Season of Docs weitere Mittel, die Sie nutzen konnten?

Zwei Mitglieder des SIG GloriousPickle PickleDocs SIG haben als technische Redakteure gearbeitet (eines in Europa und eines in Argentinien). Sie halfen uns, die Arbeit einzuschätzen und ähnliche Projektbudgets zu finden, indem wir die Entwurfsarbeiten, die sie zuvor geleistet hatten, verglichen. Außerdem hatten wir 1.000$an unbeschränkten Sponsorship-Geld aus unserer PicklePals-Convention von 2019 übrig, die wir dem Projekt zugewiesen haben.

Unvorhergesehene Ausgaben trugen dazu bei, dass unsere technischen Redakteure einen WLAN-Hotspot mieten konnten, da sie sich in einem Gebiet befanden, das von Waldbränden betroffen war und in ihrem Haus keinen Internetzugang mehr hatte. Außerdem verschickten wir weniger T-Shirts an die Teilnehmer, als wir geplant hatten, also hat sich das ausgeglichen.

Darüber hinaus haben wir uns entschieden, eine GloriousPickle-Autorin, @Piccalily (die früher eine professionelle Redakteurin in ihrem Leben ohne Pickle war) zu bezahlen, damit sie beim Kopieren und Korrekturlesen der Dokumentation des technischen Redakteurs hilft.

Teilnehmer

Wer hat an diesem Projekt gearbeitet? (Auf Wunsch der Teilnehmer Nutzernamen verwenden) Wie haben Sie Ihren technischen Redakteur gefunden und eingestellt? Wie haben Sie andere Freiwillige oder bezahlte Teilnehmer gefunden? Welche Rollen hatte das Unternehmen? Ist jemand abgebrochen? Was haben Sie über Personalbeschaffung, Kommunikation und Projektmanagement gelernt?

Das Kernteam, das an diesem Projekt arbeitete, bestand aus:

• @Dillicious, @KimChiCook (PickleDocs SIG)
• @Piccalily (Texteditor)
• @GherKen, @VinegarViv (Admin-Hilfe, GPPSC)
• @BBChips, @GloriousPicklePat (Fachleute)
• Sam Scribe (Technischer Autor)

Wir haben Sam Scribe in der GitHub-Repository-Liste Die Google-Staffel der Dokumente gefunden. Wir waren der Meinung, dass ihre Erfahrungen (Sam war für ein kulinarisches Magazin gearbeitet und Dokumentationen für Websites geschrieben hatten) gut zu unserem Projekt passten. Sam nahm am zweiwöchentlichen Anruf von PickleDocs SIG teil, sprach mit uns über das Projekt und machte einige sehr nützliche Vorschläge, die wir in den Vorschlag aufgenommen haben. Wir haben auch zwei andere technische Redakteure kontaktiert, die uns über die Netzwerke unseres SIG-Mitglieds bekannt sind, aber keiner von beiden war während des Programms erreichbar.

Da sich Sams Zeitzone nur ein paar Stunden mit den meisten Mitgliedern der PickleDocs SIG überschnitt, haben wir einen Anruf in unserem Diskussionsforum für Picklers gesendet, die sich in Sams Zeitzone aufhielten und mit dem Prozess zum Hinzufügen von Zutaten vertraut waren. @BBChips beantwortete ehrenamtlich Fragen für Sam und half ihnen dabei, bei Bedarf andere Experten zu finden. @GloriousPicklePat meldete sich auch freiwillig, um Sam zu helfen, die zugrunde liegende Architektur des Tools und mögliche Fehlermeldungen der API zu verstehen, und gab Hilfe von GitHub und Git zur Verfügung.

Leider musste @VinegarViv in der Mitte des Programms aus persönlichen Gründen vom Projekt zurücktreten. GPPSC-Mitglied @GherKen kümmerte sich um Verwaltungs- und Zahlungsfragen.

Nach einigen verpassten Fragen (GloriousPickle verwendet eine kostenlose Slack-Instanz und gelegentlich wird die Diskussion so schnell verschoben, dass Unterhaltungen aufgrund der Begrenzung der Archivierung verloren gehen) haben wir gelernt, dass wir eine Liste der laufenden Fragen in einem freigegebenen Dokument führen sollten (wir haben ein freigegebenes Google-Dokument verwendet). Die Mitglieder des SIG-Teams von PickleDocs überprüften sie vor jeder Besprechung und stellten sicher, dass sie vor dem Ende der Besprechung die Antworten erhielten. Sam konnte @BBChips bei dringenden Fragen direkt anpingen.

Wir waren sehr zufrieden mit Sam und Sam. Wir haben nicht nur die GloriousPickle-Dokumentation aktualisiert, sondern auch selbst ein begeisterter Pickler geworden.

Zeitplan

Gib einen kurzen Überblick über den Zeitplan deines Projekts. Gib dabei das geschätzte Enddatum oder zwischenzeitliche Meilensteine an, wenn das Projekt noch andauert.

Während wir darauf gewartet haben, dass im Rahmen des Google Season of Docs-Programms teilnehmende Organisationen bekannt gegeben wurden, suchten die Mitglieder von PickleDocs SIG nach früheren Arbeiten, von denen wir dachten, dass sie für Sam nützlich wären. Im Laufe eines Monats haben wir einige Notizen aus einer früheren Bemühung zur Aktualisierung der Dokumentation gefunden, die ins Stocken geraten war. Außerdem haben wir Teile der Materialien zur Prüfung der Reife der Dokumentation im Google Opendocs-Repository durchgearbeitet.

Nachdem wir die gute Nachricht erhalten hatten, dass wir für die Google-Staffel von Google Docs ausgewählt wurden, trafen sich Sam und die PickleDocs SIG und erarbeiteten einen groben Zeitplan:

Phase	Abgeschlossen von
Dokumentprüfung ansehen	7. Mai
3 Anwendungsfälle für Reibungslog 3	14. Mai
Reibungspunkte mit @GloriousPicklePat und @BBChips überprüfen und Fragen beantworten	28. Mai
Erster Entwurf der aktualisierten Dokumente – Anwendungsfall 1	25. Juni
Anwendungsfall 1 Entwurf geprüft von @GloriousPicklePat und @KimChiCook	2. Juli
Erster Entwurf der aktualisierten Dokumente – Anwendungsfall 2	2. Juli
Anwendungsfall 2 Entwurf geprüft von @GloriousPicklePat und @Dillicious	9. Juli
Erster Entwurf der aktualisierten Dokumente – Anwendungsfall 3	9. Juli
Anwendungsfall 3 Entwurf geprüft von @Dillicious und @KimChiCook	16. Juli
Alle Abfragen, die für alle Anwendungsfälle beantwortet wurden	30. Juli
Der größte Teil von PickleDocs SIG war vom 1. bis 20. August im Urlaub	--
Mit dem Testen neuer Dokumente in der Community beginnen (Dokumente, die als Entwürfe auf der GloriousPickle-Website veröffentlicht wurden)	21. August
Testfeedback eingebunden	10. September
Neue Dokumente kopieren und Korrekturlesen	17. September
Entwurfsstatus von Dokumenten entfernt, Dokumente offiziell eingeführt	28. September
Prozess zum Aktualisieren der Dokumentation erstellt	1. November
Diese Fallstudie erstellte	8. November
Fallstudie eingereicht	16. November

In unserem Angebotsbudget hatten wir geschätzt, dass die technische Redakteurin 10 bis 15 Stunden pro Woche an unserem Projekt arbeiten würde. Sam zeichnete die aufgewendete Zeit auf und nutzte durchschnittlich 11,5 Stunden pro Woche.

Ergebnisse

Was wurde erstellt, aktualisiert oder anderweitig geändert? Geben Sie Links zu veröffentlichten Dokumentationen an, falls verfügbar. Gab es im Angebot Liefergegenstände, die nicht erstellt wurden? Führen Sie auch diese auf.

Drei Hauptanwendungsfälle wurden in umfassenden Nutzeranleitungen dokumentiert:

So fügen Sie GloriousPickle eine neue Zutat hinzu

So fügen Sie GloriousPickle eine Zutat für Varianten hinzu

Eine Zutat in GloriousPickle aktualisieren oder korrigieren

Diese Leitfäden enthielten auch neue Vorlagen für Pull-Anfragen, um Beiträge einfacher zu machen.

Außerdem erstellte Sam während des Projekts ein kleines Pickle-Glossar mit von ihnen gelernten Begriffen, das auch auf der GloriousPickle-Projektwebsite veröffentlicht wurde.

Wir haben unserem Projekt-Wiki Anweisungen zur Aktualisierung dieser Benutzeranleitungen hinzugefügt.

Wir hatten einen Spickzettel für Mitwirkende, die neu bei GitHub sind, erstellt, um sie bei der Verwendung unserer Prozesse und Tools zu unterstützen. Nachdem wir uns jedoch die verfügbaren Ressourcen angesehen hatten, konnten wir stattdessen einen Spickzettel für ein anderes Projekt erstellen.

Messwerte

Welche Metriken haben Sie ausgewählt, um den Erfolg des Projekts zu messen? Konnten Sie diese Messwerte erfassen? Korrelieren die Metriken gut oder schlecht mit den Ergebnissen, die Sie sich für das Projekt gewünscht haben? Haben sich Ihre Messwerte seit dem Vorschlag geändert?

In unserem Vorschlag haben wir zwei Messwerte vorgeschlagen:

• Anzahl der zutatenbezogenen Pull-Anfragen
• Anzahl der Pull-Anfragen von neuen Beitragenden

Im September (dem ersten vollen Monat seit der Veröffentlichung des Dokumentationsentwurfs) stieg die Anzahl der zusatzstoffbezogenen Pull-Anfragen um 5 % (von 20 im August auf 21 im September). Außerdem gab es drei neue Beitragende, die insgesamt vier Pull-Anfragen stellten (im Vergleich zu zwei neuen Mitwirkenden, die zwei Pull-Anfragen im August gestellt haben). Wir planen, diese Messwerte monatlich zu erfassen.

Ab dem 1. Januar beobachten wir außerdem die Anzahl der Mitwirkenden, die insgesamt mehr als drei Beiträge geleistet haben, und beginnen vierteljährlich nach der Veröffentlichung der Dokumentation.

Wir sind der Meinung, dass diese neue Dokumentation dazu beigetragen hat, dass neue Mitwirkende der GloriousPickle-Inhaltsdatenbank etwas hinzufügen können. Ein neuer Beitragender erwähnte im Kommentar seiner PR, dass er es bereits ausprobiert hatte, sein Update aber nicht abgeschlossen hatte, da er den Prozess nicht verstanden hatte.

Analyse

Was hat gut funktioniert? Was war unerwartet? Welche Hürden oder Rückschläge gab es? Betrachten Sie Ihr Projekt als erfolgreich? Warum bzw. warum nicht? (Falls es noch zu früh ist, das zu beurteilen, erklären Sie, wann Sie damit rechnen, den Erfolg Ihres Projekts bewerten zu können.)

Wir sind sehr zufrieden mit dem Ergebnis des Projekts zur Vorbereitung auf die Google-Dokumente und betrachten es als Erfolg. Die neue Dokumentation ist übersichtlich und hilfreich, und die Anzahl der ersatzstoffbezogenen Pull-Anfragen und der Pull-Anfragen von neuen Mitwirkenden ist bereits gestiegen.

Außerdem freuten wir uns über die Teilnahme fast der gesamten GloriousPickle-Community, indem sie Feedback zum ursprünglichen Vorschlag gegeben und die neuen Dokumente als Entwurf getestet haben.

Wir standen vor einigen unerwarteten Hürden – wir waren froh, dass die Waldbrände in Sams Bundesstaat nicht mehr Schaden verursachten als ein Internetausfall. Wir bedauern auch, @VinegarViv aus dem Projekt zu verlieren. Wir wünschen ihr und ihrer Familie das Beste und hoffen, sie bald wieder sehen zu können.

Als Sam mit der Arbeit an der Dokumentation begann, wurde uns nicht klar, wie viele Begriffe und Akronyme im Zusammenhang mit Essiggurken nicht von Personen, die an unserem Projekt begannen, ohne viel Hintergrundwissen sahen würden. Sam hat jedoch den Wunsch, eine Liste aller unbekannten Begriffe zu erstellen und sie durch eigene Recherchen und durch die Frage der Community-Mitglieder nach Erklärungen und Verweisen zu definieren. Dieses Pickle-Glossar ist eine große Hilfe dabei, in Zukunft mehr Leute in der Pickle-Community willkommen zu heißen.

Zusammenfassung

Fassen Sie Ihre Projekterfahrungen in 2 bis 4 Absätzen zusammen. Heben Sie hervor, was Sie gelernt haben und was Sie in Zukunft anders machen würden. Welchen Rat würden Sie anderen Projekten geben, die ein ähnliches Problem mit der Dokumentation lösen möchten?

Kurz gesagt: Unsere Erfahrung war mit einem Hacking-Angriff verstört. Wir haben unsere Liefergegenstände aus der Dokumentation erreicht und unsere Metriken scheinen im Einklang mit unseren Zielen zu sein.

Der Erfolg des Projekts war ausschlaggebend dafür, wie glücklich wir uns bei der Zusammenarbeit mit unserem technischen Redakteur Sam Scribe gekümmert haben. [Ich habe das nicht geschrieben – Sam] Sam hatte zwar keine Erfahrung mit Pickling oder Erfahrung mit GitHub, als erfahrener technischer Autor konnte er aber gerne in ein neues Fachgebiet eintauchen, Fragen stellen und Recherchen anstellen. Sam nahm nicht nur unsere Projekttools (wir verwenden eine Kanban-Tafel, um den Überblick über die Arbeit zu behalten), sondern auch unsere Pickle-Witze auf! Wir freuen uns sehr, dass Sam die Peeling-Käfer erkannt hat und wir sie in unserer Community „abgefüllt“ haben.

Anderen Projekten würden wir Folgendes empfehlen:

• Halten Sie Ihre Angebote klein und übersichtlich. (Ursprünglich wollten wir die Dokumentation für die Verwendung unseres Schätzers mit industriellen Beizeigeranlagen in unseren Vorschlag aufnehmen, haben sie aber nur ausgelassen, weil ein Mitglied der Gemeinde, das intensiv an der Open-Source-Firmenmaschine beteiligt ist, im Rahmen des Programms seine Doktorarbeit schrieb.) Am Ende hatten wir mehr als genug Arbeit, um Sam auf Trab zu halten.
• Nutze dein Netzwerk, wenn du nach einem technischen Redakteur suchst. Bitten Sie alle Personen in Ihrer Community um Empfehlungen. Obwohl wir Sam über den GitHub-Bericht zur Google-Staffel von Docs gefunden haben, waren wir zuversichtlich, mit ihm zusammenzuarbeiten, da wir während des Bewerbungszeitraums mit mehreren Personen gesprochen haben.
• Begrüßen Sie den technischen Redakteur in Ihrer Community! Sam erzählte uns, dass die Begeisterung der GloriousPicklers es ihnen leicht machte, Fragen zu stellen.
• Unterstützen Sie Ihren technischen Redakteur dabei, Open-Source-Kenntnisse zu erwerben. Sam hatte Git noch nie verwendet, aber nach ein paar Tutorials konnte er sich schnell einarbeiten. Zuerst war Sam darüber besorgt, wie viel Feedback von der Community kommen könnte und wie er es umsetzen könnte. Das „grobe Konsensmodell“ unserer Community („Ein Konsens wird erreicht, wenn alle Probleme angegangen werden, aber nicht unbedingt berücksichtigt werden) sorgte dafür, dass Sam in der Lage war, Kritik mit seinem technischen Fachwissen einzugehen.

Anhang

Wenn Sie auf andere Materialien verlinken möchten, z. B. einen Vertrag über die Zusammenarbeit mit einem technischen Redakteur, den Sie teilen möchten, Vorlagen für Ihr Dokumentationsprojekt oder andere offene Dokumentationsressourcen, können Sie diese hier auflisten und verlinken. Der Anhang ist auch ein guter Ort, um Links zu Dokumentationstools oder Ressourcen anzugeben, die Sie verwendet haben, oder einen Ort, an dem Sie Danksagungen oder Danksagungen hinzufügen können, die möglicherweise nicht in die obigen Abschnitte passen.

Danksagung

Unser Team möchte sich an die folgenden Personen und Dinge erinnern:

• @Dillicious möchte sich bei ihrer Partnerin und auch beim Low-Fi-Hip-Hop-Radio bedanken.
• @KimChiCook möchte sich bei seinem 할머니 dafür bedanken, dass er ihm beigebracht hat, wie man eingelegt wird.
• @Piccalily möchte dem Chicago Handbuch of Style Online danken
• @GherKen möchte seinen drei Kindern dafür danken, dass sie all die Essiggurken gegessen haben, die er zubereiten kann.
• @VinegarViv möchte sich beim Rest des Teams dafür bedanken, dass er ihren Rücktritt angenommen hat.
• @BBChips bedankt sich bei Tunnocks Caramel Wafers, dem besten Essen ohne Pickle
• @GloriousPicklePat möchte sich bei PickleDocs SIG für die Übernahme dieses Projekts bedanken.
• Sam Scribe möchte der gesamten GloriousPickle-Community danken, insbesondere den Picklers, die ihnen während der Gläserknappheit im Sommer 2021 Konservengläser geschickt haben, damit sie auf dem Weg zu vielen leckeren Essiggurken beginnen.