Aktuelle Phase:
Das Season of Docs-Programm 2021 endete am 14. Dezember 2021. Siehe Zeitachse.
Verwenden Sie diese Vorlagenüberschriften, um Ihren eigenen Fallstudienbericht zu erstellen.
Titel
Organisation oder Projekt: Name der Organisation (Link zur Seite oder Website Ihrer Organisation für die Season of Docs)
Beschreibung der Organisation: Ein Elevator Pitch, der einen kurzen Überblick über die Tätigkeit Ihrer Organisation oder Ihres Projekts gibt.
Autoren: Optional: Liste der Autoren der Fallstudie; bei Bedarf Nutzernamen verwenden
Problembeschreibung
Welches Problem wollten Sie mit der neuen oder verbesserten Dokumentation lösen?
Zusammenfassung des Angebots
Eine kurze Zusammenfassung Ihres ursprünglichen Organisationsvorschlags. Verlinken Sie nach Möglichkeit die Seite mit dem Vorschlag auf Ihrer Projektwebsite.
Projektbeschreibung
Angebot erstellen
Wie sind Sie auf die Idee für Ihren Season of Docs-Vorschlag gekommen? Welchen Prozess hat Ihre Organisation zur Entscheidungsfindung verwendet? Wie haben Sie Feedback eingeholt und berücksichtigt?
Budget
Fügen Sie einen kurzen Abschnitt zu Ihrem Budget hinzu. Wie haben Sie die Arbeit geschätzt? Gab es unerwartete Kosten? Haben Sie weniger ausgegeben als den Zuschussbetrag? Hatten Sie andere Mittel außerhalb von Season of Docs, die Sie nutzen konnten?
Teilnehmer
Wer hat an diesem Projekt gearbeitet? Geben Sie bei Bedarf die Nutzernamen an. Wie haben Sie Ihren technischen Redakteur gefunden und eingestellt? Wie haben Sie andere freiwillige Helfer oder bezahlte Teilnehmer gefunden? Welche Rollen hatten sie? Hat jemand das Programm abgebrochen? Was haben Sie über Personalbeschaffung, Kommunikation und Projektmanagement gelernt?
Zeitachse
Geben Sie einen kurzen Überblick über den Zeitplan Ihres Projekts. Geben Sie das geschätzte Enddatum oder Zwischenmeilensteine an, falls das Projekt noch läuft.
Ergebnisse
Was wurde erstellt, aktualisiert oder anderweitig geändert? Fügen Sie gegebenenfalls Links zu veröffentlichter Dokumentation hinzu. Gab es im Angebot Arbeitsergebnisse, die nicht erstellt wurden? Geben Sie diese auch an.
Messwerte
Welche Messwerte haben Sie ausgewählt, um den Erfolg des Projekts zu messen? Konnten Sie diese Messwerte erfassen? Entsprachen die Messwerte den gewünschten Ergebnissen des Projekts? Haben sich Ihre Messwerte seit Ihrem Vorschlag geändert?
Analyse
Was hat gut funktioniert? Was war unerwartet? Welche Hürden oder Rückschläge haben Sie erlebt? Halten Sie Ihr Projekt für erfolgreich? Warum bzw. warum nicht? (Wenn es noch zu früh ist, um das zu beurteilen, erklären Sie, wann Sie den Erfolg Ihres Projekts voraussichtlich beurteilen können.)
Zusammenfassung
Fassen Sie Ihre Projekterfahrung 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?
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 nicht in die oben genannten Abschnitte passen.