<Name der Organisation>: <Jahr> Fallstudie für Google Season of Docs
Name der Organisation oder des Projekts:
Link zu Season of Docs:
Beschreibung der Organisation: Ein Elevator Pitch aus ein bis zwei Sätzen, der einen kurzen Überblick über die Tätigkeit Ihrer Organisation oder Ihres Projekts gibt.
Autoren: Listen Sie die Autoren der Fallstudie auf. Verwenden Sie bei Bedarf Nutzernamen (optional).
Zusammenfassung
Füllen Sie die folgende Tabelle aus und geben Sie kurze Antworten auf die Fragen. Weitere Details können Sie in späteren Abschnitten angeben. Wir empfehlen, zuerst die detaillierten Abschnitte zu verfassen und dann die Zusammenfassung zu schreiben.
| # Tech Writers | TW-Projektstunden | Budget | % des Projekts abgeschlossen |
|---|---|---|---|
| ## | ## | X $ | X % |
Welches Problem wollten Sie lösen? Und wie haben Sie versucht, es zu lösen?
Was waren die Ergebnisse Ihres Projekts?
Was hat gut funktioniert? Und was würden Sie anders machen?
Welchen Rat würden Sie anderen Projekten geben, die versuchen, ein ähnliches Problem mithilfe von Dokumentation zu lösen?
Projektbeschreibung
Beschreiben Sie das Projekt, indem Sie die folgenden Abschnitte ausfüllen.
Projektvorschlag
Geben Sie eine kurze Zusammenfassung Ihres Vorschlags und einen Link zur Vorschlagsseite auf Ihrer Projektwebsite an.
Angebotserstellung
Wie sind Sie auf die Idee für Ihren Google Season of Docs-Vorschlag gekommen? Welchen Prozess hat Ihr Unternehmen zur Entscheidungsfindung für eine Idee verwendet? Wie haben Sie Feedback eingeholt und eingearbeitet? Wer hat am Prozess teilgenommen? Wie lange hat es gedauert?
Budget
Beantworten Sie die Fragen in der folgenden Tabelle.
| Wie viel Geld haben Sie angefordert? | |
| Wie sind Sie auf diese Schätzung gekommen? | |
| Wie viele Arbeitsstunden haben Sie für das Projekt eingeplant? | |
| Wie viele Arbeitsstunden waren für das Projekt tatsächlich erforderlich? | |
| Welche anderen Ausgaben haben Sie in Ihr Budget aufgenommen? | |
| Gab es während des Projekts Budgetüberraschungen (z.B. Fehleinschätzungen)? Wenn ja, mach bitte nähere Angaben. |
Tech Writer Recruitment
Wie haben Sie Ihren technischen Redakteur gefunden und eingestellt? Hat der Prozess gut funktioniert? Sind sie für die Dauer des Projekts geblieben?
Andere Teilnehmer
Wer hat noch an diesem Projekt gearbeitet? Geben Sie bei Bedarf die Nutzernamen an. Wie haben Sie sie rekrutiert? Welche Rollen hatten sie? Sind sie während der gesamten Projektlaufzeit geblieben?
Zeitachse
Geben Sie einen kurzen Überblick über den Zeitplan Ihres Projekts. Geben Sie das voraussichtliche Enddatum oder Zwischenmeilensteine an, falls das Projekt noch läuft. Musste der ursprüngliche Zeitplan angepasst werden?
Ergebnisse
Füllen Sie die folgenden Tabellen aus, um zu beschreiben, was während des Projekts erstellt, aktualisiert oder anderweitig geändert wurde. Fügen Sie sowohl geplante als auch nicht geplante Arbeitsergebnisse hinzu. Geben Sie auch Dinge an, die geplant, aber nicht abgeschlossen wurden.
Geplante Leistungen
Relevante Links können veröffentlichte Dokumente, Pull-Requests oder andere Artefakte sein.
| Umfang | Gesamtprozentsatz | Relevante Links | Hinweise |
|---|---|---|---|
| Ergebnis 1 | |||
| … | |||
| Arbeitsergebnis N |
Nicht geplante Leistungen
Wurden Liefergegenstände erstellt, die zu Beginn des Projekts nicht geplant waren? Falls ja, erläutern Sie dies bitte.
Messwerte
Welche Messwerte haben Sie ausgewählt, um den Erfolg des Projekts zu messen? Konnten Sie diese Messwerte erfassen? Haben Sie eine Veränderung als Folge des Projekts festgestellt? Haben Sie seit Ihrem Vorschlag Messwerte hinzugefügt oder entfernt? Wie oft möchten Sie in Zukunft Messwerte erfassen?
Analyse
Beschreiben Sie kurz, wie das Projekt abgelaufen ist. War das Projekt erfolgreich? Warum bzw. warum nicht? Oder wann können Sie den Erfolg beurteilen? Gab es unerwartete Hürden oder Rückschläge? Hat das Projekt zu neuen oder aktualisierten Prozessen oder Verfahren in Ihrer Organisation geführt?
Gewonnene Erkenntnisse
Verwenden Sie die folgenden Tabellen, um die gewonnenen Erkenntnisse hervorzuheben – für Dinge, die gut gelaufen sind, und Dinge, die verbessert werden könnten. Verwenden Sie die aufgeführten Themenkategorien nach Bedarf oder fügen Sie eigene hinzu. Sie können bei Bedarf mehrere Zeilen für ein bestimmtes Thema verwenden. Diese Erkenntnisse fließen in unsere zusammenfassende Liste der Best Practices für Dokumentationsprojekte ein.
Was hat gut funktioniert?
Fügen Sie eigene Erkenntnisse hinzu oder geben Sie bei einer der Best Practices von Google Season of Docs ein „Plus eins“ an.
| Thema | Unser Ansatz | Gewonnene Erkenntnisse |
|---|---|---|
| Budget | ||
| Kommunikation | ||
| Persönlicher Mentor | ||
| Messwerte | ||
| Onboarding | ||
| Teilnehmer | ||
| Projektliefergegenstände | ||
| Projektmanagement | ||
| Personalbeschaffung und -einstellung | ||
| … | ||
| <Other Topics as Needed> | ||
Was könnte verbessert werden?
Fügen Sie eigene Erkenntnisse hinzu oder geben Sie bei einer der Best Practices von Google Season of Docs ein „Plus eins“ an.
| Thema | Unser Ansatz | Was wir anders machen würden | Gewonnene Erkenntnisse |
|---|---|---|---|
| Budget | |||
| Kommunikation | |||
| Persönlicher Mentor | |||
| Messwerte | |||
| Onboarding | |||
| Teilnehmer | |||
| Projektliefergegenstände | |||
| Projektmanagement | |||
| Personalbeschaffung und -einstellung | |||
| … | |||
| <Other Topics as Needed> | |||
Anhang
Wenn Sie andere Materialien haben, auf die Sie verlinken möchten (z. B. einen Vertrag für die Zusammenarbeit mit Ihrem technischen Redakteur, den Sie teilen möchten, oder Vorlagen für Ihr Dokumentationsprojekt oder andere offene Dokumentationsressourcen), können Sie sie hier auflisten und verlinken. Im Anhang können Sie auch Links zu den von Ihnen verwendeten Dokumentationstools oder ‑ressourcen auflisten oder Danksagungen oder Erwähnungen hinzufügen, die in die vorherigen Abschnitte nicht passen.