Tahap saat ini:
Hasil diumumkan
linimasa.
Panduan ini ditujukan bagi administrator organisasi yang mendaftar atau berpartisipasi dalam program Season Dokumen.
Apakah organisasi Anda harus berpartisipasi dalam program Season Dokumen?
Gunakan pertanyaan berikut untuk membantu memahami apakah organisasi atau proyek open source Anda harus berpartisipasi dalam Season Dokumen.
Apakah organisasi atau proyek Anda:
- Percaya bahwa dokumentasi baru atau yang diperbarui akan membantu mencapai tujuan atau memecahkan masalah dalam proyek atau komunitas Anda?
- Memiliki pemahaman awal atau hipotesis tentang bagaimana Anda akan mengukur keberhasilan proyek dokumentasi?
- Memiliki anggota komunitas yang bersedia membantu merekrut, mengevaluasi, dan menjalankan orientasi untuk seorang penulis teknis, dan siapa yang akan bersedia menjawab pertanyaan dan memberikan dukungan lain selama proyek berlangsung (6-8 bulan, termasuk periode pendaftaran)?
- Punya anggota komunitas yang bersedia melayani sebagai administrator organisasi dan berkoordinasi dalam pembuatan aplikasi, menjawab pertanyaan dari administrator program, dan mengirim evaluasi bulanan serta evaluasi akhir dan studi kasus? Administrator organisasi juga harus bersedia menjawab survei tindak lanjut setelah menyelesaikan program Season Dokumen.
Organisasi Anda juga harus memenuhi persyaratan kelayakan program, termasuk kemampuan untuk membuat akun Open Collective.
Proses pengajuan permohonan organisasi
Fase eksplorasi
Meskipun pendaftaran Season Dokumen dibuka pada 23 Februari 2022, 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, sasaran, atau masalah, kemungkinan solusi dokumentasi, dan kemungkinan metrik. Halaman ini harus bersifat publik, dan memungkinkan kontribusi dan diskusi komunitas. Sertakan informasi untuk penulis teknis yang ingin berpartisipasi—di mana mereka harus mengajukan pertanyaan, menyatakan minat, atau mencari tahu lebih lanjut tentang project Anda? Sebaiknya tambahkan alamat email untuk menghubungi organisasi open source Anda terkait Season Dokumen. Namun, kami sangat menyarankan agar tidak menggunakan alamat email pribadi sebagai alamat email untuk menghubungi organisasi open source 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 Menulis Dokumen Slack. Halaman promosi dan pers menyertakan logo dan konten lainnya yang dapat Anda gunakan saat membahas Season Dokumen.
- Untuk setiap ide dokumentasi, pertimbangkan pengalaman dan kualifikasi yang dibutuhkan seorang penulis teknis agar berhasil bekerja sama dengan komunitas dan organisasi Anda. Keterampilan apa yang dapat membantu komunitas Anda untuk mengembangkan penulis teknis (misalnya, menggunakan GitHub atau toolchain dokumen Anda)? (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 penerapan
- Pilih ide yang paling menjanjikan dari halaman proposal. Setiap organisasi
hanya dapat mengirimkan satu proposal. Beberapa hal yang perlu dipertimbangkan:
- Ide mana yang paling diminati dari penulis teknis?
- Ide mana yang akan membantu memecahkan masalah terbesar proyek Anda? Lebih baik memilih ide yang lebih berisiko yang akan memiliki dampak lebih besar daripada ide untuk proyek dokumentasi yang lebih mungkin diselesaikan tetapi tidak akan membuat perbedaan signifikan bagi proyek Anda.
- Apakah ide ini membutuhkan partisipasi anggota tertentu di 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 Anda juga harus menyertakan anggaran. Proposal yang tidak lengkap tidak akan dipertimbangkan.
Kirimkan Formulir Permohonan sebelum batas waktu pendaftaran 25 Maret 2022 pukul 18:00 UTC. Proposal yang diterima akan diumumkan pada 14 April 2022.
Pengembangan dan pelaporan proyek
{i>Kickoff<i} (permulaan) proyek
- Jika organisasi Anda telah memilih penulis atau penulis teknis untuk proyek, adakan {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 ketertarikan dari penulis teknis yang tertarik, buat pengumuman publik tentang pilihan penulis teknis Anda atau beri tahu pemohon tentang keputusan Anda.
Memberikan pembayaran
- Season of Docs akan menyetorkan 40% dana hibah ke akun Open Collective setiap organisasi setelah mereka menyewa penulis teknis, mulai 9 Juni 2022. Sebaiknya organisasi membuat jadwal pembayaran dengan penulis teknis berdasarkan pencapaian project, termasuk pembayaran saat dimulainya project.
- 60% sisanya akan disetorkan ke akun Open Collective organisasi yang menyelesaikan dan mengirimkan evaluasi akhir dan studi kasus mereka, mulai 14 Desember 2022. Perlu diperhatikan bahwa semua project yang berhasil, terlepas dari linimasa penyelesaian project (misalnya, project 3 bulan vs. 6 bulan), akan mulai menerima pembayaran akhir pada 14 Desember 2022
- 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 periksa folder spam Anda).
Evaluasi akhir proyek dan studi kasus
Organisasi harus menyelesaikan dan mengirimkan evaluasi akhir project dan studi kasus sebelum 30 November 2022 pukul 18.00 UTC untuk menerima dana hibah yang tersisa.
Evaluasi akhir
Formulir evaluasi akhir akan tersedia bagi administrator organisasi paling satu bulan sebelum 30 November 2022 pukul 18.00 UTC.
Contoh kisah sukses
Studi kasus Season Dokumen merupakan hasil utama dari partisipasi organisasi Anda di Season Dokumen. 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 baik), hal-hal yang Anda pelajari, dan pertanyaan yang diajukan.
Silakan 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 Anda sebagai link di formulir evaluasi akhir.
Studi kasus Anda akan dipublikasikan di situs Season of Docs, jadi ingatlah hal tersebut ketika menyertakan informasi tentang project Anda.
Kami mewajibkan organisasi berpartisipasi dalam setidaknya tiga survei tindak lanjut untuk membantu kami melacak keberhasilan project Musim Dokumen dari waktu ke waktu.
Formulir
| Formulir | Tautkan | Batas waktu |
|---|---|---|
| Aplikasi organisasi | Aplikasi organisasi kini ditutup. Bergabunglah dengan milis pengumuman di season-of-docs-announce untuk mendapatkan informasi terbaru. |
25 Maret 2022 pada pukul 18.00 UTC |
| Informasi pembayaran organisasi | Formulir ini belum tersedia. |
12 Mei 2022 pukul 18.00 UTC |
| Bukti perekrutan penulis teknis | Fase perekrutan penulis teknis selesai. |
16 Mei 2022 pukul 18.00 UTC |
| Evaluasi bulanan | Fase evaluasi bulanan telah ditutup. |
Lihat linimasa |
| Evaluasi proyek akhir dan studi kasus | Fase evaluasi project telah ditutup. |
30 November 2022 pukul 18.00 UTC |
| Survei lanjutan | Formulir tersedia selama tahap survei tindak lanjut (2 Mei 2023). |
Lihat linimasa |
Informasi terkait
- Tinjau Linimasa Dokumen.