Membuat studi kasus

Fase saat ini:
Program Dokumen Musim 2021 selesai pada 14 Desember 2021. Lihat linimasa.

Sebagai bagian dari Musim Dokumen 2021, organisasi diwajibkan untuk mengirimkan evaluasi akhir dan studi kasus. Gunakan template studi kasus dan contoh studi kasus kami sebagai panduan untuk membuat studi kasus project Anda sendiri.

Formulir evaluasi akhir akan tersedia setidaknya satu bulan sebelum 30 November 2021 pukul 18.00 UTC.

Ringkasan studi kasus

{i>Template<i} studi kasus akan mencakup bagian-bagian berikut:

  • Pernyataan masalah: masalah apa yang Anda coba selesaikan dengan dokumentasi baru atau yang sudah diperbaiki?
  • Abstrak proposal: ringkasan singkat dari proposal organisasi asli
  • Deskripsi proyek: deskripsi naratif tentang proyek Anda. Sertakan:
    • Cara Anda membuat proposal (dan tautan ke halaman ide proyek asli).
    • Bagaimana Anda merekrut dan memilih penulis teknis atau peserta lain.
    • Siapa yang mengerjakan proyek ini (gunakan nama pengguna jika diminta oleh peserta).
    • Berapa lama waktu yang dibutuhkan untuk menyelesaikan proyek (jika selesai).
    • Hal apa yang berjalan dengan baik?
    • Hal apa yang tidak terduga? Hambatan atau hambatan apa yang Anda hadapi?
    • Dokumentasi apa yang dibuat, diperbarui, ditingkatkan, atau dihapus?
  • Apakah proyek ini menghasilkan proses atau prosedur baru atau yang diperbarui di organisasi Anda?
  • Metrik:
    • Metrik apa yang dipilih untuk mengukur keberhasilan proyek?
    • Apakah Anda berhasil mengumpulkan metrik tersebut?
    • Apakah mereka berkorelasi dengan perilaku atau tolok ukur yang Anda harapkan?
    • Apakah metrik yang Anda pilih berubah? Apakah Anda menghapus atau menambahkan metrik?
    • Menurut metrik Anda, apakah proyek Anda berhasil? (Mungkin terlalu dini untuk mengatakannya.)
    • Seberapa sering Anda ingin mengumpulkan metrik untuk ke depannya?
  • Ringkasan:
    • Dalam 2-4 paragraf, rangkum pengalaman Anda dalam proyek. Apakah yang Anda peroleh? Hal berbeda apa yang akan Anda lakukan di masa mendatang? Saran apa yang akan Anda berikan pada proyek mencoba memecahkan masalah serupa dengan dokumentasi?

Panduan studi kasus

  • Menyimpan catatan mingguan berisi pembaruan proyek akan membantu Anda membuat studi kasus. Untuk setiap minggu, catat progres project (termasuk link ke permintaan pull, masalah, atau percakapan, jika berguna), apa yang berjalan dengan baik (atau tidak dengan baik), hal-hal yang Anda pelajari, dan pertanyaan yang diajukan.
  • Saat menulis studi kasus, bersikaplah baik. Hindari kesalahan dan jaga agar hal tersebut tetap membangun. Ingatlah bahwa studi kasus bersifat publik!
  • Gunakan nada yang sama dalam studi kasus seperti yang Anda lakukan pada postingan blog atau tutorial; jangan terlalu formal.