Fase saat ini:
Hasil diumumkan. Lihat
linimasa.
Gunakan panduan ini sebagai template untuk membuat proposal project organisasi Anda.
PROPOSAL TITLE - organization name
Judul proposal Anda harus singkat dan spesifik. “Memperbarui Panduan Kontributor ORGNAME” adalah judul proposal yang baik. “Peningkatan Dokumentasi” terlalu samar; “Memperbarui Bagian 5,7,23,99 Panduan Kontributor, Membuat FAQ, dan Membuat Panduan Gaya” terlalu panjang.
Tentang organisasi Anda
Di bagian ini, beri tahu kami tentang organisasi atau project Anda dalam beberapa paragraf singkat. Masalah apa yang diselesaikan oleh project Anda? Siapa pengguna dan kontributor Anda? Sudah berapa lama organisasi atau project Anda berdiri? Berikan beberapa konteks untuk membantu kami memahami mengapa mendanai proposal Anda akan menciptakan dampak positif di open source dan dunia.
GloriousPickle (versi saat ini 1.2.3, rilis pertama pada tahun 2009) adalah library berlisensi MIT untuk menghitung rasio garam, gula, cuka, dan rempah-rempah yang sempurna dengan mudah untuk setiap sayuran yang dapat dibuat acar, dalam jumlah mulai dari satu mentimun kecil hingga kargo radish. 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 makanan mengubah sayuran dengan masa simpan singkat menjadi acar dalam toples yang stabil, membantu memberi makan orang-orang yang kelaparan di banyak komunitas, dan mengurangi pemborosan makanan. Selain itu, pengguna mengirimkan metrik opsional tentang penggunaan GloriousPickle kepada kami, yang kami gunakan untuk membuat PickleSet, set data besar untuk membuat resep acar baru melalui machine learning.
Tentang project Anda
Masalah project Anda
Beri tahu kami masalah yang akan dibantu diselesaikan oleh project Anda. Mengapa penting bagi organisasi atau project Anda untuk menyelesaikan masalah ini?
Pengguna ingin dapat menambahkan informasi tentang bumbu baru dan bahan lainnya (terutama bahan dari masakan non-Eropa) ke alat GloriousPickle. Sayangnya, proses untuk menambahkan informasi ini tidak didokumentasikan dengan baik, yang berarti calon kontributor harus membuka masalah dalam project untuk mendapatkan bantuan (atau mereka menyerah sama sekali). Proses ini juga mengasumsikan bahwa kontributor sudah memahami proses permintaan pull dan GitHub, meskipun banyak pengguna kami yang bukan developer profesional.
Makin banyak informasi bahan yang kami miliki, makin bermanfaat GloriousPickle bagi semua pengguna kami.
Cakupan project Anda
Beri tahu kami dokumentasi apa yang akan dibuat, diperbarui, atau ditingkatkan oleh organisasi Anda. Jika ada pekerjaan yang sengaja tidak dilakukan, sertakan juga informasi tersebut. Sertakan estimasi waktu, dan apakah Anda telah mengidentifikasi sukarelawan organisasi dan penulis teknis untuk mengerjakan project Anda.
Project GloriousPickle (dengan nama kode PicklePlus) akan:
- Audit dokumentasi yang ada dan buat log hambatan dokumentasi saat ini untuk tiga kasus penggunaan teratas (menambahkan bahan baru, menambahkan bahan varian, dan memperbarui atau mengoreksi informasi tentang bahan).
- Dengan menggunakan log hambatan sebagai panduan untuk memahami kesenjangan dalam dokumentasi, buat dokumentasi yang diperbarui untuk kasus penggunaan teratas.
- Buat “tips cepat” singkat untuk membantu kontributor yang baru menggunakan permintaan pull dan GitHub agar mereka dapat menggunakan proses kami.
- Menyertakan masukan dari penguji dokumentasi (relawan dalam project) dan komunitas GloriousPickle yang lebih luas.
- Bekerja sama dengan tim rilis untuk memperbarui dokumentasi di situs GloriousPickle, dan untuk membuat proses agar dokumentasi tetap sinkron dengan alat update ke depannya.
Pekerjaan yang berada di luar cakupan project ini:
- Project ini tidak akan membuat proses untuk penautan silang antara ejaan atau nama yang berbeda untuk bahan yang sama.
- Project ini tidak akan membuat tutorial GitHub apa pun; sebagai gantinya, tips akan ditautkan ke materi yang sudah ada yang relevan dan bermanfaat.
Kami memiliki dua kandidat penulis teknis yang kuat untuk project ini, dan kami memperkirakan pekerjaan ini akan selesai dalam waktu tiga bulan. SIG PickleDocs GloriousPickle dan @GloriousPicklePat (pengelola inti API penambahan bahan) telah berkomitmen untuk mendukung project ini.
Mengukur keberhasilan project
Bagaimana Anda akan mengetahui bahwa dokumentasi baru telah membantu menyelesaikan masalah Anda? Metrik apa yang akan Anda gunakan, dan bagaimana cara melacaknya?
GloriousPickle menerima rata-rata sepuluh permintaan pull per kuartal untuk menambahkan atau memperbarui bahan baru (diberi tag 'ingredient'). Sebagian besar permintaan pull ini (>60%) berasal dari kontributor sebelumnya. Kami yakin bahwa dokumentasi yang ditingkatkan 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 yakin bahwa meningkatkan kualitas 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 membuat lebih dari tiga kontribusi secara keseluruhan, mulai setiap tiga bulan setelah dokumentasi dipublikasikan.
Kami akan menganggap project 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 membuat >3 kontribusi meningkat sebesar 10% (dimulai pada kuartal setelah dokumentasi dipublikasikan)
Linimasa
Berapa lama waktu yang Anda perkirakan untuk menyelesaikan pekerjaan ini? Dapatkah Anda mengelompokkan tugas penulis teknis menurut bulan/minggu?
Proyek itu sendiri akan memerlukan waktu sekitar enam bulan untuk diselesaikan. Setelah penulis teknologi direkrut, kami akan menghabiskan waktu satu bulan untuk orientasi penulis teknologi, lalu beralih ke log audit dan hambatan, dan 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 | Membuat dokumentasi |
| November | Penyelesaian project |
Anggaran project
Panduan umum
- Anda dapat menyertakan anggaran dalam proposal, atau sebagai link terpisah. Jika anggaran Anda kurang dari sepuluh item, sebaiknya sertakan dalam proposal Anda.
- Semua anggaran harus dalam dolar AS. Kami memperkirakan hibah berkisar antara US$5.000 hingga US$15.000; jika project Anda berada di luar rentang tersebut, harap berikan informasi tambahan untuk membenarkan anggaran Anda.
- Kami memperkirakan sebagian besar anggaran Anda (minimal 60-70%) akan dialokasikan untuk penulis teknis yang mengerjakan project Anda. Sebaiknya buat anggaran per project jika memungkinkan.
- Kami berharap project open source menggunakan alat open source jika memungkinkan; jika project Anda benar-benar memerlukan dana untuk lisensi atau dukungan software eksklusif, sertakan justifikasi untuk jumlah tersebut.
- Biaya lainnya yang mungkin terjadi mencakup:
- Pekerjaan desain untuk membuat branding, logo, template, atau aset desain lainnya untuk situs dokumentasi Anda
- Jumlah minimum (<US$200) untuk merchandise project (kaos atau stiker untuk peserta Anda). Jika Anda menggunakan logo Google Season of Docs, logo tersebut harus disertai dengan nama atau logo project atau organisasi Anda. Merchandise Anda tidak boleh menggunakan nama Google.
- Stipend minimal untuk sukarelawan yang memiliki peran pembimbingan atau panduan yang signifikan dalam project (sebaiknya tidak lebih dari $500 per sukarelawan)
- Donasi downstream ke project open source lainnya tidak boleh lebih dari 10% dari total anggaran Anda.
- Sertakan item anggaran lainnya sesuai kebutuhan, beserta justifikasi untuk jumlah yang dicari. Justifikasi pengeluaran harus menyoroti bagaimana pengeluaran akan berkontribusi pada keberhasilan project secara keseluruhan.
Sampel anggaran
| Item anggaran | Jumlah | Total yang Dijalankan | Catatan/justifikasi |
|---|---|---|---|
| Penulis teknis mengaudit, memperbarui, menguji, dan memublikasikan dokumentasi baru tentang proses penambahan bahan untuk GloriousPickle | 5000,00 | 5000,00 | |
| Tunjangan sukarelawan | 500 | 6.500,00 | 3 stipend sukarelawan x 500 |
| Kaus project (10 kaus) | 150,00 | 6.650,00 | |
| Unicorn tiup raksasa (versi 4,6 meter) | 99.99 | 6.749,99 | Kami akan memberikan unicorn tiup kepada tim yang menjawab pertanyaan penulis teknis dengan paling cepat selama periode pengembangan project |
| TOTAL | 6.749,99 |
Informasi tambahan
Sertakan di sini informasi tambahan apa pun yang relevan dengan proposal Anda.
Pengalaman sebelumnya dengan penulis teknis atau dokumentasi: Jika Anda atau mentor Anda pernah bekerja sama dengan penulis teknis sebelumnya, atau telah mengembangkan dokumentasi, sebutkan hal ini dalam permohonan Anda. Jelaskan dokumentasi yang Anda buat dan cara Anda bekerja sama dengan penulis teknis. Misalnya, jelaskan proses peninjauan yang Anda gunakan, atau bagaimana keterampilan penulis teknis berguna untuk project Anda. Jelaskan bagaimana pengalaman sebelumnya ini dapat membantu Anda bekerja dengan penulis teknis di Google Season of Docs.
Partisipasi sebelumnya dalam Google Season of Docs, Google Summer of Code, atau lainnya: Jika Anda atau salah satu mentor Anda telah berpartisipasi dalam 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 Google Season of Docs.