Tahap saat ini:
Hasil diumumkan
linimasa.
Gunakan panduan ini sebagai template untuk membuat proposal project organisasi Anda.
PROPOSAL TITLE - nama organisasi
Judul proposal harus singkat dan spesifik. “Perbarui Panduan Kontributor ORGNAME” adalah judul proposal yang bagus. “Peningkatan Dokumentasi” terlalu samar; “Update Pasal 5,7,23,99 Panduan Kontributor, Membuat FAQ, dan Panduan Gaya Membuat” terlalu panjang.
Tentang organisasi Anda
Di bagian ini, ceritakan tentang organisasi atau proyek Anda dalam beberapa paragraf singkat. Masalah apa yang diselesaikan oleh proyek Anda? Siapa pengguna dan kontributor Anda? Berapa lama organisasi atau proyek Anda telah ada? Berikan konteks untuk membantu kami memahami mengapa pendanaan proposal Anda akan menciptakan dampak positif terhadap open source dan dunia.
GloriousSelectle (versi 1.2.3 saat ini, rilis pertama pada tahun 2009) adalah perpustakaan berlisensi MIT untuk dengan mudah menghitung rasio sempurna garam, gula, cuka, dan rempah-rempah untuk setiap sayuran yang dapat diasin, dalam jumlah mulai dari satu mentimun bayi tunggal hingga muatan lobak dalam kontainer. Kontributor kami adalah penggemar acar dari seluruh dunia, dan pengguna kami adalah koki rumahan, koki restoran, dan orang-orang yang bekerja di bidang logistik untuk perusahaan dan organisasi pemrosesan makanan besar. Pengguna terbesar kami adalah organisasi yang membantu bank pangan mengubah sayuran yang berumur pendek menjadi stoples acar yang stabil, membantu memberi makan orang-orang yang lapar di banyak komunitas, dan mengurangi limbah makanan. Selain itu, pengguna kami mengirimi kami metrik opsional tentang penggunaan GloriousPilih, yang kami gunakan untuk memproduksi PickleSet, set data besar untuk membuat resep acar baru melalui machine learning.
Tentang project Anda
Masalah proyek Anda
Beri tahu kami masalah yang akan dibantu oleh project Anda. Mengapa penting bagi organisasi atau project Anda untuk menyelesaikan masalah ini?
Pengguna ingin dapat menambahkan informasi tentang rempah-rempah baru dan bahan lainnya (terutama bahan-bahan dari masakan non-Eropa) ke alat GloriousChoosele. Sayangnya, proses untuk menambahkan informasi ini tidak didokumentasikan dengan baik, yang berarti calon kontributor harus membuka masalah dalam proyek untuk mendapatkan bantuan (atau mereka menyerah sama sekali). Proses ini juga mengasumsikan bahwa kontributor sudah familier dengan proses permintaan pull kami dan dengan GitHub, meskipun banyak pengguna kami bukan developer profesional.
Semakin banyak informasi bahan yang kami miliki, semakin berguna GloriousPilihle bagi semua pengguna!
Ruang lingkup proyek Anda
Beri tahu kami tentang dokumentasi yang akan dibuat, diperbarui, atau ditingkatkan kualitasnya oleh organisasi Anda. Jika beberapa pekerjaan sengaja tidak dilakukan, sertakan juga informasi itu. Sertakan perkiraan waktu, dan apakah Anda sudah mengidentifikasi sukarelawan organisasi dan penulis teknis untuk mengerjakan project Anda.
Project GloriousChoosele (bernama kode PicklePlus) akan:
- Mengaudit dokumentasi yang ada dan membuat log friksi dokumentasi saat ini untuk tiga kasus penggunaan teratas (menambahkan bahan baru, menambahkan bahan varian, dan memperbarui atau mengoreksi informasi tentang suatu bahan).
- Dengan menggunakan log hambatan sebagai panduan untuk memahami celah dalam dokumentasi, buat dokumentasi terbaru untuk kasus penggunaan teratas.
- Buat “tips praktis” singkat untuk membantu kontributor yang baru mengenal permintaan pull dan GitHub agar mereka dapat menggunakan proses kita.
- Memasukkan masukan dari penguji dokumentasi (sukarelawan dalam project) dan komunitas GloriousSelectle yang lebih luas.
- Bekerja samalah dengan tim rilis untuk memperbarui dokumentasi di situs GloriousPilih, dan untuk membuat proses untuk menjaga dokumentasi tetap sinkron dengan alat update ke depannya.
Pekerjaan yang berada di luar ruang lingkup proyek ini:
- Project ini tidak akan membuat proses cross-link antara ejaan atau nama yang berbeda untuk bahan yang sama.
- Project ini tidak akan membuat tutorial GitHub; sebagai gantinya, tips praktis akan menautkan ke materi yang ada yang relevan dan bermanfaat.
Kami memiliki dua kandidat penulis teknis yang kuat untuk proyek ini, dan kami memperkirakan pekerjaan ini akan memakan waktu tiga bulan. Gloriousdip PickleDocs SIG dan @GloriousPilihlePat (pemelihara inti API tambahan bahan) telah berkomitmen untuk mendukung proyek.
Mengukur keberhasilan proyek Anda
Bagaimana Anda tahu bahwa dokumentasi baru tersebut telah membantu memecahkan masalah Anda? Metrik apa yang akan Anda gunakan, dan bagaimana cara melacaknya?
GloriousSelectle menerima rata-rata sepuluh permintaan pull per kuartal untuk menambahkan atau memperbarui bahan-bahan baru (yang diberi tag 'bahan'). Sebagian besar permintaan pull ini (>60%) berasal dari kontributor sebelumnya. Kami yakin bahwa peningkatan dokumentasi ini akan menghasilkan lebih banyak permintaan pull dan lebih banyak permintaan pull dari kontributor baru. Karena sebagian besar kontributor aktif kami memulai dengan menambahkan bahan, kami juga berpikir meningkatkan dokumentasi ini akan menghasilkan lebih banyak kontributor aktif secara keseluruhan.
Kami akan melacak dua metrik (jumlah permintaan pull terkait bahan dan jumlah permintaan pull dari kontributor baru) setiap bulan setelah dokumentasi dipublikasikan. Kami juga akan melacak jumlah kontributor yang telah memberikan lebih dari tiga kontribusi secara keseluruhan, mulai setiap tiga bulan setelah dokumentasi dipublikasikan.
Kami akan menganggap proyek itu berhasil jika, setelah publikasi dokumentasi baru:
- Jumlah permintaan pull terkait bahan meningkat sebesar 20%
- Jumlah permintaan pull dari kontributor baru meningkat sebesar 15%
- Jumlah kontributor yang telah memberikan >3 kontribusi meningkat sebesar 10% (awal kuartal setelah dokumentasi dipublikasikan)
Rentang waktu
Berapa lama perkiraan waktu yang diperlukan untuk pekerjaan ini? Apakah Anda dapat memerinci tugas penulis teknis berdasarkan bulan/minggu?
Proyek itu sendiri akan memakan waktu sekitar enam bulan. Setelah penulis teknologi dipekerjakan, kami akan mempelajari orientasi penulis teknologi selama satu bulan, lalu beralih ke log audit dan friksi, serta menghabiskan beberapa bulan terakhir untuk berfokus pada pembuatan dokumentasi.
| Tanggal | Poin Tindakan |
|---|---|
| Mei | Orientasi |
| Juni - Agustus | Mengaudit dokumentasi yang ada dan membuat log hambatan |
| September - Oktober | Buat dokumentasi |
| November | Penyelesaian proyek |
Anggaran proyek
Pedoman umum
- Anda dapat menyertakan anggaran dalam proposal Anda, atau sebagai link terpisah. Jika anggaran Anda kurang dari sepuluh item, sebaiknya sertakan dalam proposal.
- Semua anggaran harus dalam dolar AS. Kami memperkirakan hibah berkisar dari US$5.000 hingga US$15.000; jika proyek Anda di luar rentang tersebut, berikan informasi tambahan untuk menjustifikasi anggaran Anda.
- Kami berharap sebagian besar anggaran Anda (minimal 60-70%) akan dialokasikan kepada penulis teknis yang mengerjakan proyek Anda. Jika memungkinkan, sebaiknya buat anggaran per project.
- Kami berharap proyek open source menggunakan alat open source jika memungkinkan; jika project Anda benar-benar membutuhkan dana untuk lisensi atau dukungan software eksklusif, sertakan justifikasi terkait jumlah tersebut.
- Kemungkinan pengeluaran lainnya meliputi:
- Karya desain untuk membuat branding, logo, template, atau aset desain lainnya untuk situs dokumentasi Anda
- Jumlah minimal (<US$200) untuk suvenir proyek (kaus atau stiker untuk peserta). Jika Anda menggunakan logo Season untuk Dokumen, logo atau nama tersebut harus disertai dengan logo atau nama project atau organisasi Anda. Suvenir Anda tidak boleh tidak menggunakan nama Google.
- Gaji minimal untuk sukarelawan yang mengambil peran bimbingan atau bimbingan yang cukup dalam proyek (sebaiknya tidak lebih dari $500 per sukarelawan)
- Donasi downstream ke project open source lainnya tidak boleh melebihi 10% dari total anggaran Anda.
- Sertakan item anggaran lain sesuai kebutuhan, bersama dengan justifikasi untuk jumlah yang dicari. Justifikasi pengeluaran harus menyoroti bagaimana pengeluaran akan berkontribusi pada keberhasilan proyek secara keseluruhan.
Sampel anggaran
| Item anggaran | Jumlah | Total Berjalan | Catatan/pembenaran |
|---|---|---|---|
| Penulis teknis mengaudit, mengupdate, menguji, dan memublikasikan dokumentasi baru tentang proses penambahan bahan untuk GloriousPilihle | 5.000,00 | 5.000,00 | |
| Tunjangan sukarelawan | 500 | 6500.00 | 3 iuran sukarelawan masing-masing x 500 |
| Kaus proyek (10 kaus) | 150.00 | 6.650,00 | |
| Unicorn tiup raksasa (versi 15 kaki) | 99.99 | 6.749,99 | Kami akan memberikan unicorn tiup kepada tim yang menjawab pertanyaan penulis teknis dengan cepat selama periode pengembangan proyek |
| TOTAL | 6.749,99 |
Informasi tambahan
Sertakan informasi tambahan apa pun yang relevan dengan proposal Anda di sini.
Pengalaman sebelumnya dengan penulis teknis atau dokumentasi: Jika Anda atau salah satu mentor Anda pernah bekerja sama dengan penulis teknis, atau telah mengembangkan dokumentasi, sebutkan hal ini dalam aplikasi Anda. Jelaskan dokumentasi yang Anda hasilkan dan cara Anda bekerja dengan penulis teknis. Misalnya, jelaskan proses peninjauan yang Anda gunakan, atau bagaimana keterampilan penulis teknis berguna untuk proyek Anda. Jelaskan bagaimana pengalaman sebelumnya dapat membantu Anda bekerja dengan penulis teknis di Season Dokumen.
Partisipasi sebelumnya di Season of Docs, Google Summer of Code, atau lainnya: Jika Anda atau salah satu mentor Anda telah mengikuti Google Summer of Code atau program serupa, sebutkan hal ini dalam permohonan Anda. Jelaskan pencapaian Anda dalam program tersebut. Jelaskan bagaimana pengalaman ini dapat memengaruhi cara Anda bekerja di Season Dokumen.