Eine Fallstudie erstellen

Aktuelle Phase:
Das Docs-Programm 2021 endete am 14. Dezember 2021. Siehe Zeitachse.

Im Rahmen der Season of Docs 2021 müssen Organisationen eine abschließende Bewertung und Fallstudie einreichen. Verwenden Sie unsere Vorlage für Fallstudien und die Beispielfallstudie als Leitfaden, um die Fallstudie Ihres eigenen Projekts zu erstellen.

Das endgültige Bewertungsformular ist mindestens einen Monat vor dem 30. November 2021 um 18:00 Uhr (UTC) verfügbar.

Fallstudie – Übersicht

Die Fallstudienvorlage enthält die folgenden Abschnitte:

  • Problembeschreibung: Welches Problem wollten Sie mit der neuen oder verbesserten Dokumentation lösen?
  • Abstraktes Angebot: eine kurze Zusammenfassung des ursprünglichen Organisationsvorschlags
  • Projektbeschreibung: Eine narrative Beschreibung Ihres Projekts. Einschließen:
    • Wie Sie Ihren Vorschlag erstellt haben (und Link zur ursprünglichen Seite mit Projektideen)
    • Wie Sie einen technischen Redakteur oder andere Teilnehmer rekrutiert und ausgewählt haben.
    • Wer an dem Projekt gearbeitet hat (verwenden Sie Nutzernamen, wenn die Teilnehmenden dazu aufgefordert werden).
    • Wie lange hat das Projekt gedauert (falls abgeschlossen).
    • Was hat gut funktioniert?
    • Was war unerwartet? Welche Hürden oder Rückschläge haben Sie erlebt?
    • Welche Dokumentation wurde erstellt, aktualisiert, verbessert oder entfernt?
  • Hat dieses Projekt zu neuen oder aktualisierten Prozessen oder Verfahren in Ihrer Organisation geführt?
  • Messwerte:
    • Welche Metriken wurden ausgewählt, um den Erfolg des Projekts zu messen?
    • Konnten Sie diese Messwerte erfassen?
    • Entsprachen sie den erwarteten Verhaltensweisen oder Benchmarks?
    • Haben sich die ausgewählten Messwerte geändert? Haben Sie Messwerte entfernt oder hinzugefügt?
    • Ist Ihr Projekt laut Ihren Metriken erfolgreich? Möglicherweise ist es noch zu früh, um das zu beurteilen.
    • Wie oft möchten Sie in Zukunft Messwerte erheben?
  • Zusammenfassung:
    • Fassen Sie Ihre Projekterfahrung in 2 bis 4 Absätzen zusammen. Was haben Sie gelernt? Was würden Sie in Zukunft anders machen? Welchen Rat würden Sie Projekten geben, die ein ähnliches Problem mit der Dokumentation lösen möchten?

Leitfaden für Fallstudien

  • Ein wöchentliches Protokoll über Projekt-Updates hilft Ihnen bei der Erstellung Ihrer Fallstudie. Notieren Sie für jede Woche den Projektfortschritt (einschließlich Links zu Pull-Requests, Problemen oder Unterhaltungen, sofern nützlich), was gut (oder nicht gut) gelaufen ist, was Sie gelernt haben und welche Fragen gestellt wurden.
  • Seien Sie beim Verfassen Ihrer Fallstudie freundlich. Vermeiden Sie Schuldzuweisungen und bleiben Sie konstruktiv. Denken Sie daran, dass Fallstudien öffentlich sind.
  • Verwenden Sie in Ihrer Fallstudie denselben Ton wie in einem Blogpost oder Tutorial. Vermeiden Sie einen übermäßig formellen Stil.