Fase saat ini:
Pengembangan dokumentasi. Lihat
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 baik. "Peningkatan Dokumentasi" terlalu samar; "Memperbarui Bagian 5,7,23,99 Panduan Kontributor, Membuat FAQ, dan Panduan Membuat Gaya" terlalu panjang.
Tentang organisasi Anda
Di bagian ini, beri tahu kami tentang organisasi atau proyek Anda dalam beberapa paragraf singkat. Masalah apa yang diselesaikan oleh proyek Anda? Siapa pengguna dan kontributor Anda? Sudah berapa lama organisasi atau proyek Anda ada? Berikan konteks untuk membantu kami memahami mengapa pendanaan proposal Anda akan menciptakan dampak positif di open source dan dunia.
GloriousPilihle (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 acar yang mungkin, dalam jumlah mulai dari satu mentimun bayi tunggal hingga muatan kontainer lobak. 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 lama menjadi acar yang stabil, membantu memberi makan orang-orang yang lapar di banyak komunitas, dan mengurangi limbah makanan. Selain itu, pengguna kami mengirimkan metrik opsional tentang penggunaan GloriousChoosele, 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 dapat diselesaikan 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 saja). Proses ini juga mengasumsikan bahwa kontributor sudah familier dengan proses permintaan pull kami dan dengan GitHub, meskipun banyak pengguna kami yang bukan developer profesional.
Semakin banyak informasi bahan yang kita miliki, semakin bermanfaat Gloriouspickuple bagi semua pengguna!
Ruang lingkup proyek Anda
Beri tahu kami dokumentasi yang akan dibuat, diperbarui, atau ditingkatkan oleh organisasi Anda. Jika beberapa pekerjaan sengaja tidak dilakukan, sertakan juga informasi itu. Sertakan perkiraan waktu, dan apakah Anda telah mengidentifikasi sukarelawan organisasi dan penulis teknis untuk mengerjakan project Anda.
Project GloriousChoosele (bernama kode PicklePlus) akan:
- Mengaudit dokumentasi yang ada dan membuat log friksi dari 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 friksi sebagai panduan untuk memahami kesenjangan 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 kami.
- Gabungkan masukan dari penguji dokumentasi (sukarelawan dalam project) dan komunitas GloriousChoosele yang lebih luas.
- Bekerja samalah dengan tim rilis untuk memperbarui dokumentasi di situs Gloriousdipre, 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 sudah ada yang relevan dan bermanfaat.
Kami memiliki dua kandidat penulisan teknis yang kuat untuk proyek ini, dan kami memperkirakan bahwa pekerjaan ini akan memakan waktu tiga bulan. Gloriouslet PickleDocs SIG dan @GloriousChooselePat (pemelihara inti API tambahan bahan) telah berkomitmen untuk mendukung project ini.
Mengukur keberhasilan proyek Anda
Bagaimana Anda akan tahu bahwa dokumentasi baru telah membantu menyelesaikan masalah? Metrik apa yang akan Anda gunakan, dan bagaimana cara memantaunya?
GloriousChoosele menerima rata-rata sepuluh permintaan pull dalam setiap kuartal untuk menambahkan atau memperbarui bahan-bahan baru ('bahan' yang diberi tag). 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-bahan, kami juga berpikir bahwa meningkatkan kualitas dokumentasi ini akan menghasilkan kontributor yang lebih 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 tiga bulanan 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 lebih dari 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 setiap bulan atau minggu?
Proyek ini sendiri akan memakan waktu sekitar enam bulan. Setelah penulis teknologi dipekerjakan, kami akan berfokus pada orientasi penulis teknologi selama sebulan, 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 friksi |
| September - Oktober | Membuat dokumentasi |
| November | Penyelesaian proyek |
Anggaran proyek
Pedoman umum
- Anda dapat menyertakan anggaran dalam proposal Anda, atau sebagai tautan terpisah. Jika anggaran Anda kurang dari sepuluh item, sebaiknya sertakan dalam proposal Anda.
- Semua anggaran harus dalam dolar AS. Kami memperkirakan hibah berkisar dari US$5.000 hingga US$15.000; jika proyek Anda berada di luar rentang tersebut, berikan informasi tambahan untuk membenarkan anggaran Anda.
- Kami berharap sebagian besar anggaran Anda (minimum 60-70%) akan dialokasikan kepada penulis teknis yang mengerjakan proyek Anda. Jika memungkinkan, sebaiknya buat anggaran per proyek.
- Kami harap proyek open source dapat menggunakan alat open source bila memungkinkan; jika proyek Anda benar-benar membutuhkan dana untuk lisensi atau dukungan perangkat lunak eksklusif, sertakan pembenaran atas jumlahnya.
- Pengeluaran lainnya yang mungkin mencakup:
- Desain pekerjaan untuk membuat {i>branding<i}, logo, {i>template<i}, atau aset desain lainnya untuk situs dokumentasi Anda
- Jumlah minimal (<US$200) untuk suvenir proyek (kaus atau stiker untuk peserta). Jika Anda menggunakan logo Google Season of Dokumen, logo atau nama organisasi harus disertai dengan logo atau nama project atau organisasi Anda. Suvenir Anda tidak boleh menggunakan nama Google.
- Gaji minimal untuk sukarelawan yang mengambil peran bimbingan atau bimbingan yang cukup besar dalam proyek (kami menyarankan tidak lebih dari $500 per sukarelawan)
- Donasi downstream ke proyek open source lainnya tidak boleh lebih dari 10% dari total anggaran Anda.
- Menyertakan item anggaran lainnya sesuai kebutuhan, beserta 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/justifikasi |
|---|---|---|---|
| Penulis teknis mengaudit, memperbarui, menguji, dan memublikasikan dokumentasi baru tentang proses penambahan bahan untuk GloriousChoosele | 5.000,00 | 5.000,00 | |
| Tunjangan sukarelawan | 500 | 6.500,00 | 3 tunjangan sukarelawan x masing-masing 500 |
| Kaus proyek (10 kaus) | 150,00 | 6.650,00 | |
| Unicorn tiup raksasa (versi 15 kaki) | 99.99 | 6749,99 | Kami akan memberikan unicorn tiup kepada tim yang menjawab pertanyaan penulis teknis dengan cepat selama periode pengembangan proyek |
| TOTAL | 6749,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 hasilkan dan cara Anda bekerja sama dengan penulis teknis. Misalnya, jelaskan proses tinjauan yang Anda gunakan, atau bagaimana keterampilan penulis teknis berguna untuk proyek Anda. Jelaskan bagaimana pengalaman sebelumnya ini dapat membantu Anda bekerja sama dengan penulis teknis di Google Season Dokumen.
Partisipasi sebelumnya di Google Season of Docs, Google Summer of Code, atau lainnya: Jika Anda atau mentor Anda pernah mengambil bagian 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 Dokumen.