Membuat studi kasus

Fase saat ini:
Program Season of Docs 2021 berakhir pada 14 Desember 2021. Lihat linimasa.

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

Formulir evaluasi akhir akan tersedia tidak kurang dari satu bulan sebelum 30 November 2021 pukul 18.00 UTC.

Ringkasan studi kasus

Template studi kasus akan menyertakan bagian-bagian berikut:

  • Pernyataan masalah: masalah apa yang Anda coba pecahkan dengan dokumentasi baru atau yang ditingkatkan?
  • Abstrak proposal: ringkasan singkat proposal organisasi asli
  • Project description: deskripsi naratif tentang project Anda. Sertakan:
    • Cara Anda membuat proposal (dan link ke halaman ide project asli).
    • Cara Anda merekrut dan memilih penulis teknis atau peserta lainnya.
    • Siapa yang mengerjakan project (gunakan nama pengguna jika diminta oleh peserta).
    • Berapa lama waktu yang diperlukan untuk menyelesaikan project (jika sudah selesai).
    • Apa saja yang berjalan dengan baik?
    • Apa yang tidak terduga? Hambatan atau kemunduran apa yang Anda hadapi?
    • Dokumentasi apa yang dibuat, diperbarui, ditingkatkan, atau dihapus?
  • Apakah project ini menghasilkan proses atau prosedur baru atau yang diperbarui di organisasi Anda?
  • Metrik:
    • Metrik apa yang dipilih untuk mengukur keberhasilan project?
    • Apakah Anda dapat mengumpulkan metrik tersebut?
    • Apakah hasil tersebut 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 project Anda berhasil? (Mungkin terlalu awal untuk mengetahuinya.)
    • Seberapa sering Anda ingin mengumpulkan metrik ke depannya?
  • Ringkasan:
    • Dalam 2-4 paragraf, rangkum pengalaman project Anda. Apa yang Anda pelajari? Apa yang akan Anda lakukan dengan cara yang berbeda di masa mendatang? Saran apa yang akan Anda berikan kepada project yang mencoba memecahkan masalah serupa dengan dokumentasi?

Panduan studi kasus

  • Membuat log mingguan tentang pembaruan project akan membantu Anda membuat studi kasus. Untuk setiap minggu, catat progres project (termasuk link ke permintaan pull, masalah, atau percakapan, jika berguna), hal-hal yang berjalan dengan baik (atau tidak baik), hal-hal yang Anda pelajari, dan pertanyaan yang diajukan.
  • Saat menulis studi kasus, bersikaplah baik. Hindari menyalahkan dan tetaplah konstruktif. Ingat bahwa studi kasus bersifat publik.
  • Gunakan nada yang sama dalam studi kasus Anda seperti yang Anda lakukan untuk postingan blog atau tutorial; jangan terlalu formal.