Fase saat ini:
Program Dokumen Season 2021 selesai pada 14 Desember 2021. Lihat
linimasa.
Panduan ini ditujukan bagi administrator organisasi yang mendaftar atau berpartisipasi dalam program Dokumen Musim 2021.
Haruskah organisasi Anda berpartisipasi dalam program Dokumen Musim 2021?
Gunakan pertanyaan ini untuk membantu Anda memahami apakah proyek atau organisasi open source Anda harus berpartisipasi dalam Season Dokumen.
Apakah organisasi atau proyek Anda:
- Percayakah bahwa dokumentasi baru atau yang diperbarui akan membantu mencapai suatu tujuan atau memecahkan masalah dalam proyek atau komunitas Anda?
- Memiliki pemahaman awal tentang atau hipotesis tentang bagaimana Anda akan mengukur keberhasilan proyek dokumentasi?
- Apakah anggota masyarakat bersedia untuk membantu merekrut, mengevaluasi, dan mengorientasikan seorang penulis teknis, dan siapa yang akan bersedia untuk menjawab pertanyaan dan memberikan dukungan lain selama proyek berlangsung (6-8 bulan, termasuk periode pendaftaran)?
- Apakah ada anggota komunitas yang bersedia berperan sebagai administrator organisasi dan berkoordinasi dalam membuat aplikasi, menjawab pertanyaan dari administrator program, dan mengirim evaluasi bulanan serta evaluasi akhir dan studi kasus? Administrator organisasi juga harus bersedia menjawab survei lanjutan setelah menyelesaikan Dokumen Musim 2021.
Organisasi Anda juga harus memenuhi persyaratan kelayakan program, termasuk dapat membuat akun Open Collective.
Proses pengajuan permohonan organisasi
Fase eksplorasi
Meskipun pendaftaran Dokumen Musim 2021 dibuka pada 9 Februari 2021, sebaiknya organisasi meluangkan waktu untuk menyelesaikan langkah-langkah pada fase Eksplorasi sebelum mengirimkan permohonan mereka.
- Membuat halaman proposal proyek. Halaman proposal berisi daftar kebutuhan utama, tujuan, atau masalah, kemungkinan solusi dokumentasi, dan metrik yang mungkin. Halaman ini harus bersifat publik, serta memungkinkan kontribusi dan diskusi komunitas. Sertakan informasi untuk penulis teknis yang ingin berpartisipasi—di mana mereka harus mengajukan pertanyaan, menyatakan minat, atau mempelajari lebih lanjut tentang proyek Anda? (Lihat daftar ide project untuk mengetahui contohnya.)
- Publikasikan halaman proposal Anda di saluran komunitas dan tambahkan organisasi Anda ke daftar organisasi yang tertarik di Musim repositori GitHub Dokumen. Anda mungkin juga ingin membagikan link di channel #season-of-docs di bagian Menulis Dokumen Slack. Halaman promosi dan pers mencakup logo dan konten lainnya yang dapat Anda gunakan saat membahas Season Dokumen.
- Untuk setiap ide dokumentasi, pertimbangkan pengalaman dan kualifikasi apa yang dibutuhkan penulis teknis agar dapat berhasil bekerja sama dengan komunitas dan organisasi Anda. Keterampilan apa yang dapat dibutuhkan komunitas Anda untuk membantu pengembangan penulis teknis (misalnya, menggunakan GitHub atau toolchain dokumen)? (Lihat panduan untuk bekerja sama dengan penulis teknis.
- Mintalah sukarelawan untuk membantu menjawab pertanyaan dari penulis teknis yang tertarik.
- Mulailah meninjau setiap pernyataan minat yang dikirimkan dari penulis teknis yang tertarik untuk bekerja dengan proyek Anda.
Fase pendaftaran
- Pilih ide yang paling menjanjikan dari halaman proposal. Setiap organisasi
hanya dapat mengirimkan satu proposal. Beberapa hal yang perlu dipertimbangkan:
- Ide mana yang paling banyak diminati dari penulis teknis?
- Ide mana yang akan membantu memecahkan masalah terbesar proyek Anda? Sebaiknya pilih ide yang lebih berisiko yang akan memiliki dampak lebih besar daripada ide untuk project dokumentasi yang kemungkinan besar akan diselesaikan tetapi tidak akan membuat perbedaan signifikan pada project Anda.
- Apakah ide ini membutuhkan partisipasi dari anggota tertentu dari komunitas Anda? Apakah mereka memiliki waktu untuk berpartisipasi?
Buat proposal menggunakan template proposal. Pastikan Anda memahami dan menyertakan:
- Masalah yang ingin Anda atasi
- Cakupan dokumentasi yang ingin Anda tingkatkan atau buat
- Bagaimana Anda akan mengukur keberhasilan dokumentasi
Proposal juga harus menyertakan anggaran. Proposal yang tidak lengkap tidak akan dipertimbangkan.
Kirimkan Formulir Permohonan sebelum batas waktu pendaftaran 26 Maret 2021 pukul 18.00 UTC. Proposal yang diterima akan diumumkan pada 16 April 2021.
Pengembangan dan pelaporan proyek
{i>Kickoff<i} (permulaan) proyek
- Jika organisasi Anda telah memilih penulis atau penulis teknis untuk proyek Anda, lakukan {i>kickoff meeting<i} dengan penulis teknis Anda. Anda harus berkolaborasi dengan penulis teknis untuk membuat jadwal pekerjaan dan {i>check-in<i} rutin.
- Jika Anda menerima beberapa pernyataan minat dari penulis teknis yang tertarik, buat pengumuman publik tentang pilihan penulis teknis Anda atau beri tahu pelamar tentang keputusan Anda.
Memberikan pembayaran
- Season Dokumen akan menyetorkan 40% dana hibah ke akun Open Collective setiap organisasi setelah mereka menyewa penulis teknis, mulai tanggal 10 Juni 2021. Sebaiknya organisasi membuat jadwal pembayaran dengan penulis teknis berdasarkan pencapaian project, termasuk pembayaran saat memulai project.
- 60% sisanya akan disetorkan ke akun organisasi yang menyelesaikan dan mengirimkan evaluasi akhir serta studi kasus mulai 14 Desember 2021.
- Lihat panduan pembayaran untuk mengetahui informasi selengkapnya tentang cara membuat akun Open Collective.
Pelaporan status project
- Administrator organisasi harus mengisi laporan status bulanan dalam waktu satu minggu setelah menerima link ke formulir laporan status (link akan dikirim melalui email, jadi harap periksa folder spam Anda).
Evaluasi akhir proyek dan studi kasus
Organisasi harus menyelesaikan dan mengirimkan evaluasi akhir project dan studi kasus sebelum 30 November 2021 pukul 18.00 UTC untuk menerima sisa dana hibah.
Evaluasi akhir
Formulir evaluasi akhir akan tersedia bagi administrator organisasi paling lambat satu bulan sebelum 30 November 2021 pukul 18.00 UTC.
Studi kasus
Studi kasus Season of Dokumen adalah hasil utama partisipasi organisasi Anda pada Season Dokumen 2021. Menyimpan catatan mingguan pembaruan proyek akan membantu Anda membuat studi kasus. 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 telah Anda pelajari, dan pertanyaan yang diajukan.
Baca artikel membuat studi kasus untuk mengetahui informasi tambahan dan pastikan untuk mengikuti template studi kasus kami untuk membuat studi kasus Anda. Anda akan mengirimkan studi kasus sebagai link di formulir evaluasi akhir.
Studi kasus Anda akan dipublikasikan di situs Season of Docs, jadi harap diingat hal tersebut saat menyertakan informasi tentang project Anda.
Organisasi harus berpartisipasi dalam setidaknya tiga survei tindak lanjut untuk membantu kami melacak keberhasilan project Dokumen dari waktu ke waktu.
Formulir
| Formulir | Link | Batas waktu |
|---|---|---|
| Permohonan organisasi | Pendaftaran organisasi kini telah ditutup. Ikuti milis pengumuman di season-of-docs-announce untuk mengikuti perkembangan informasi. |
26 Maret 2021 pukul 18.00 UTC |
| Informasi pembayaran organisasi | 12 Mei 2021 pukul 18.00 UTC | |
| Bukti perekrutan penulis teknis | 17 Mei 2021 pukul 18.00 UTC | |
| Evaluasi bulanan | Formulir tersedia selama fase evaluasi project (5 Juni 2024). |
Lihat linimasa |
| Evaluasi proyek akhir dan studi kasus | Formulir tersedia selama evaluasi project akhir dan fase studi kasus (22 November 2024 - 10 Desember 2024). |
30 November 2021 pukul 18:00 UTC |
| Survei lanjutan | Formulir tersedia selama tahap survei tindak lanjut (1 Mei 2025). |
Lihat linimasa |
Informasi terkait
- Lihat Linimasa Season Dokumen.