Fase saat ini:
Hasil diumumkan. Lihat
linimasa.
Gunakan contoh ini untuk membantu Anda membuat laporan studi kasus Anda sendiri.
PicklePlus: Mendokumentasikan Alat Kontribusi GloriousChoosele
Organisasi atau Project: Glorious Pickle link ke situs utama organisasi atau project Anda di sini
Deskripsi Organisasi: GloriousSelectle (saat ini versi 1.2.3, 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.
Penulis: opsional: cantumkan penulis studi kasus; gunakan nama pengguna jika diminta
Pernyataan Masalah/Proposal Abstrak
Masalah apa yang Anda coba atasi dengan dokumentasi baru atau yang ditingkatkan? Tautkan ke halaman proposal di situs project Anda, jika memungkinkan.
Menambahkan bahan ke database bahan alat GloriousPilih memakan waktu dan rumit, serta alat tersebut tidak memiliki dokumentasi yang baik. Banyak calon kontributor yang tidak memiliki pengalaman menggunakan git atau membuat permintaan pull. Ini berarti GloriousSelectle memiliki celah serius pada data bahan, dan membuat alat kami kurang berguna. Dengan menyempurnakan dokumentasi untuk menambahkan bahan-bahan baru, kami berharap dapat mendorong kontributor baru dan lebih banyak acar!
Deskripsi Project
Membuat proposal
Bagaimana cara Anda mengajukan proposal Google Season Dokumen? Proses apa yang digunakan organisasi Anda untuk memutuskan sebuah ide? Bagaimana cara Anda mengumpulkan dan menyertakan masukan?
Gloriousdip PickleDocs SIG mendengar tentang program Google Season Dokumen melalui tweet dari Kantor Program Open Source Google. SIG mendiskusikan program tersebut pada pertemuan dua mingguan mereka, dan setuju untuk membuat proposal. Dua anggota SIG (@KimChiCook dan @Dillicious) secara sukarela mengerjakan draf proposal untuk ditinjau pada pertemuan berikutnya.
Setelah PickleDocs SIG menyetujui draf proposal, email dikirim ke proyek yang lebih luas untuk meminta masukan. Empat belas anggota komunitas memberikan masukan, termasuk @GloriousPilihlePat, pengelola API penambahan bahan. @GloriousPilihlePat secara sukarela menjadi narasumber selama program ini berlangsung.
Setelah mendiskusikan dan menggabungkan masukan yang diterima, proposal dikirimkan ke GloriousChoosele Project Steering Committee untuk meminta pemungutan suara. Kelima anggota GPPSC memberikan suara +1 untuk mengirimkan proposal dan permohonan, dan @VinegarViv setuju untuk membantu membuat akun Open Collective yang diperlukan untuk berpartisipasi dalam program dan mengawasi pembayaran.
Anggaran
Sertakan bagian singkat pada anggaran Anda. Bagaimana Anda memperkirakan pekerjaan itu? Apakah ada pengeluaran tak terduga? Apakah anggaran yang Anda habiskan lebih sedikit dari penghargaan hibah? Apakah Anda mengalokasikan dana dengan benar atau apakah beberapa item yang Anda anggarkan lebih banyak/lebih sedikit/tidak perlu? Apakah Anda memiliki dana lain selain Google Season Dokumen yang dapat Anda gunakan?
Dua anggota GloriousPilih PickleDocs SIG telah bekerja sebagai penulis teknis (satu di Eropa dan satu di Argentina). Mereka membantu kami memperkirakan pekerjaan dan menemukan anggaran proyek yang serupa, membandingkan pekerjaan draf proposal yang mereka lakukan sebelumnya. Kami juga memiliki sisa dana sponsor sebesar US$1000 dari konvensi PicklePals 2019 yang kami alokasikan untuk proyek tersebut.
Biaya tak terduga adalah membantu penulis teknis kami menyewa hotspot wifi, karena ia berada di area yang terkena dampak kebakaran hutan dan kehilangan akses internet di rumah mereka. Kami juga akhirnya mengirimkan lebih sedikit kaos kepada peserta dari yang kami rencanakan, sehingga hasilnya seimbang.
Selain itu, kami memutuskan untuk memberi kompensasi kepada kontributor GloriousChoosele, @Piccalily (yang pernah menjadi copyeditor profesional selama kariernya yang tidak lesu) untuk membantu copyediting dan pemeriksaan tata bahasa dokumentasi yang dibuat oleh penulis teknis.
Peserta
Siapa yang mengerjakan proyek ini (gunakan nama pengguna jika diminta oleh peserta)? Bagaimana Anda menemukan dan mempekerjakan penulis teknis? Bagaimana Anda menemukan sukarelawan lain atau peserta berbayar? Peran apa saja yang mereka miliki? Apakah ada yang berhenti? Apa yang Anda pelajari tentang perekrutan, komunikasi, dan manajemen project?
Tim inti yang mengerjakan proyek ini adalah:
- @Dillicious, @KimChiCook (PilihleDocs SIG)
- @Piccalily (copyeditor)
- @GherKen, @VinegarViv (bantuan admin, GPPSC)
- @BBChips, @GloriousPilihlePat (ahli materi pokok)
- Sam Scribe (penulis teknis)
Kami menemukan Sam Scribe melalui daftar repositori GitHub Google Season untuk Dokumen. Kami pikir pengalaman mereka (Sam pernah bekerja untuk majalah kuliner serta menulis dokumentasi untuk situs web) sangat cocok dengan proyek kami. Sam bergabung dengan sesi panggilan dua mingguan PickleDocs SIG dan berbicara tentang project tersebut dengan kami, sehingga memberikan beberapa saran berharga yang kami sertakan ke dalam proposal. Kami juga menghubungi dua penulis teknis lain yang kami kenal melalui jaringan anggota SIG, tetapi keduanya tidak ada selama jangka waktu program ini.
Karena zona waktu Sam hanya tumpang-tindih beberapa jam dengan sebagian besar anggota PickleDocs SIG, kami mengirim panggilan ke forum diskusi untuk Pickler yang berada di zona waktu Sam dan sudah familier dengan proses penambahan bahan. @BBChips mengajukan diri secara sukarela untuk menjawab pertanyaan Sam dan membantunya menemukan pakar lain sesuai kebutuhan. @GloriousChooselePat juga menjadi sukarelawan untuk membantu Sam memahami arsitektur dasar alat tersebut dan kemungkinan pesan error dari API, serta menyediakan bantuan GitHub dan git.
Sayangnya, di tengah program, @VinegarViv harus mundur dari proyek karena alasan pribadi. Anggota GPPSC @GherKen bertindak untuk menangani pertanyaan administratif dan pembayaran.
Setelah beberapa pertanyaan yang terlewat (GloriousPilihle menggunakan instance Slack gratis dan terkadang diskusi berjalan begitu cepat sehingga kami kehilangan percakapan karena batas arsip berkelanjutan). Kami menyadari bahwa kami harus menyimpan daftar pertanyaan yang berjalan di dokumen bersama (kami menggunakan Dokumen Google bersama). Anggota PickleDocs SIG memeriksanya sebelum setiap rapat dan memastikan untuk mendapatkan jawaban sebelum akhir rapat. Sam dapat langsung melakukan ping ke @BBChips untuk menjawab pertanyaan mendesak.
Kami senang sekali bisa bekerja sama dengan Sam dan Sam. Selain memperbarui dokumentasi GloriousSelectedle, kami menjadi sigap.
Linimasa
Berikan ringkasan singkat tentang linimasa project Anda (tunjukkan perkiraan tanggal akhir atau tonggak pencapaian menengah jika project sedang berlangsung).
Sementara kami menunggu program Google Season of Docs untuk mengumumkan organisasi yang berpartisipasi, para anggota PickleDocs SIG melakukan penelusuran untuk pekerjaan sebelumnya yang kami anggap akan bermanfaat bagi Sam. Selama sebulan, kami menemukan beberapa catatan dari upaya sebelumnya untuk memperbarui dokumentasi yang terhenti, dan kami juga mengerjakan beberapa bagian materi audit kematangan dokumentasi di repo opendocs Google.
Setelah kami mendapat kabar baik bahwa kami terpilih untuk mengikuti Google Season untuk Dokumen, Sam dan PickleDocs SIG bertemu dan mengerjakan jadwal yang tidak biasa:
| Tahap | Diselesaikan Oleh |
|---|---|
| Tinjau audit dokumen | 7 Mei |
| Kasus penggunaan log gesekan 3 | 14 Mei |
| Tinjau log hambatan dengan @GloriousPilihlePat dan @BBChips untuk menjawab pertanyaan | 28 Mei |
| Draf pertama kasus penggunaan dokumen yang diperbarui 1 | 25 Juni |
| Draf kasus penggunaan 1 yang ditinjau oleh @GloriousPilihlePat & @KimChiCook | 2 Juli |
| Draf pertama kasus penggunaan dokumen yang diperbarui 2 | 2 Juli |
| Draf kasus penggunaan 2 yang ditinjau oleh @GloriousPilihlePat & @Dillicious | 9 Juli |
| Draf pertama kasus penggunaan dokumen yang diperbarui 3 | 9 Juli |
| Draf kasus penggunaan 3 yang ditinjau oleh @Dillicious & @KimChiCook | 16 Juli |
| Semua pertanyaan yang dijawab di semua kasus penggunaan | 30 Juli |
| Sebagian besar PickleDocs SIG sedang berlibur pada 1-20 Agustus | -- |
| Mulai pengujian dokumen baru di komunitas (dokumen yang dipublikasikan sebagai draf di situs GloriousSelectedle) | 21 Agustus |
| Masukan pengujian disertakan | 10 September |
| Salinedit dan baca ulang dokumen baru | 17 September |
| Status draf dokumen dihapus, dokumen resmi diluncurkan | 28 September |
| Proses untuk memperbarui dokumentasi yang dibuat | 1 November |
| Studi kasus ini membuat | 8 November |
| Studi kasus dikirim | 16 November |
Dalam anggaran proposal kami, kami memperkirakan bahwa penulis teknis akan menghabiskan 10-15 jam per minggu untuk mengerjakan proyek kami. Sam menyimpan catatan waktu yang dihabiskan dan rata-rata 11,5 jam per minggu.
Hasil
Apa yang dibuat, diperbarui, atau diubah? Sertakan link ke dokumentasi yang dipublikasikan jika tersedia. Apakah ada hasil kerja/capaian dalam proposal yang tidak tercipta? Cantumkan juga semua hal tersebut.
Tiga kasus penggunaan utama didokumentasikan dengan panduan lengkap pengguna:
Cara menambahkan bahan baru ke Gloriouspickuple
Cara menambahkan bahan varian ke GloriousPilihle
Cara memperbarui atau memperbaiki bahan di Gloriouspickuple
Panduan ini juga menyertakan template permintaan pull baru untuk mempermudah kontribusi.
Selain itu, selama proyek, Sam membuat Daftar Istilah Acar kecil yang mereka pelajari, yang juga dipublikasikan di situs proyek GloriousChoosele.
Kami menambahkan petunjuk untuk memperbarui panduan cara kerja pengguna ini ke wiki proyek kami.
Kami menyertakan lembar contekan bagi kontributor yang baru mengenal GitHub untuk membantu mereka menggunakan proses dan alat kami, tetapi setelah melihat sumber daya yang tersedia, kami dapat memperoleh lembar contekan proyek lain.
Metrik
Metrik apa yang Anda pilih untuk mengukur keberhasilan project? Apakah Anda berhasil mengumpulkan metrik tersebut? Apakah metrik berkorelasi baik atau buruk dengan hasil yang Anda inginkan untuk proyek tersebut? Apakah metrik Anda berubah sejak pengajuan Anda?
Dalam proposal kami, kami mengusulkan dua metrik:
- jumlah permintaan pull terkait bahan
- jumlah permintaan pull dari kontributor baru
Untuk bulan September (bulan penuh pertama sejak publikasi draf dokumentasi) kami melihat adanya kenaikan 5% dalam permintaan pull terkait bahan (dari 20 pada Agustus menjadi 21 pada bulan September) dan kami melihat tiga kontributor baru yang membuat total empat permintaan pull (vs dua kontributor baru yang membuat dua permintaan pull pada bulan Agustus). Kami berencana untuk melacak metrik ini setiap bulan.
Mulai 1 Januari, kami juga akan melacak jumlah kontributor yang telah memberikan lebih dari tiga kontribusi secara keseluruhan, mulai triwulanan setelah dokumentasi dipublikasikan.
Secara anekdot, kami yakin dokumentasi baru ini telah membuat perbedaan dalam memungkinkan kontributor baru untuk menambahkan ke database bahan Gloriouspickuple—salah satu kontributor baru yang disebutkan dalam komentar PR mereka yang telah mereka coba sebelumnya, tetapi belum menyelesaikan pembaruannya karena mereka tidak memahami prosesnya.
Analisis
Hal apa yang berjalan dengan baik? Hal apa yang tidak terduga? Hambatan atau hambatan apa yang Anda hadapi? Apakah Anda menganggap proyek Anda berhasil? Apa alasannya? (Jika terlalu dini untuk mengatakannya, jelaskan kapan Anda dapat menilai keberhasilan proyek Anda.)
Kami sangat senang dengan hasil project Google Season Dokumen kami dan menganggapnya berhasil. Dokumentasi baru ini jelas dan bermanfaat, dan kami telah melihat peningkatan jumlah permintaan pull terkait bahan dan jumlah permintaan pull dari kontributor baru.
Kami juga senang karena hampir seluruh komunitas GloriousPilihle berpartisipasi, dengan memberikan masukan untuk proposal asli dan dengan menguji dokumen baru dalam bentuk draf.
Kami menghadapi beberapa rintangan tak terduga—kami bersyukur bahwa kebakaran hutan di negara bagian Sam tidak menyebabkan kerusakan lebih lanjut daripada pemadaman internet. Selain itu, kami menyayangkan kehilangan @VinegarViv dari proyek ini. Kami mendoakan yang terbaik untuk dia dan keluarganya dan berharap dapat segera bertemu dengannya lagi.
Satu hal yang tidak kami sadari sampai Sam mulai mengerjakan dokumentasinya adalah berapa banyak istilah dan akronim yang terkait dengan acar, yang tidak akan dikenali oleh seseorang yang datang ke proyek kami tanpa latar belakang pengawetan. Namun, Sam bertekad untuk menyimpan daftar setiap istilah yang asing dan mendefinisikannya melalui penelitian sendiri serta dengan meminta penjelasan dan referensi dari anggota komunitas. Daftar Istilah Acar ini akan sangat membantu dalam menyambut lebih banyak orang ke dalam komunitas acar di masa mendatang.
Ringkasan
Rangkum pengalaman proyek Anda dalam 2-4 paragraf. Soroti apa yang telah Anda pelajari, dan apa yang akan Anda pilih untuk dipelajari secara berbeda di masa mendatang. Saran apa yang akan Anda berikan kepada project lain yang mencoba memecahkan masalah serupa terkait dokumentasi?
Singkatnya, pengalaman kami sangat menyenangkan! Kami telah mencapai hasil dokumentasi dan metrik kami tampaknya sejalan dengan tujuan kami.
Bagian besar dari keberhasilan proyek ini adalah betapa beruntungnya kami bekerja dengan penulis teknis kami, Sam Scribe. [Saya tidak menulis ini—Sam] Meskipun Sam tidak memiliki latar belakang di bidang pengasutan atau pengalaman dengan GitHub, sebagai penulis teknis yang berpengalaman, ia nyaman menyelami bidang subjek baru, mengajukan pertanyaan, dan melakukan penelitian. Sam dengan cepat mempelajari alat-alat proyek kami (kami menggunakan papan kanban untuk melacak pekerjaan) tetapi juga lelucon kami. Kami sangat senang Sam telah berhasil menangkap kuman acar dan kami telah 'membotolkan' mereka di komunitas kami.
Kami menyarankan proyek lain untuk:
- Buat proposal Anda tetap kecil dan mudah dikelola. (Kami awalnya ingin menyertakan dokumentasi untuk menggunakan penaksir kami dengan mesin pengasir batch industri dalam proposal kami, dan hanya membatalkan karena salah satu anggota komunitas kami yang sangat terlibat dalam mesin acar open source akan menulis skripsi PhD-nya selama program ini.) Kami akhirnya memiliki lebih dari cukup pekerjaan untuk membuat Sam sibuk!
- Manfaatkan jaringan Anda saat mencari penulis teknis. Mintalah semua anggota komunitas Anda untuk memberikan rekomendasi. Meskipun kami menemukan Sam melalui Google Season untuk Dokumen GitHub, kami merasa percaya diri bekerja dengannya karena kami telah berbicara dengan beberapa orang selama periode pendaftaran.
- Sambut penulis teknis di komunitas Anda. Sam memberi tahu kami bahwa sikap antusias dari GloriousSelectedlers memudahkan untuk mengajukan pertanyaan.
- Bantu penulis teknis Anda mendapatkan keterampilan open source. Sam belum pernah menggunakan git sebelumnya, tetapi setelah mengikuti beberapa tutorial, mereka belajar dengan cepat. Pada awalnya, Sam khawatir dengan besarnya masukan yang mungkin didapatkan dari komunitas dan cara menerapkannya, tetapi model 'konsensus kasar' komunitas kami ('konsensus tercapai ketika semua masalah ditangani, tetapi belum tentu diakomodasi') membuat Sam percaya diri dalam menangani kritik menggunakan keahlian penulisan teknis mereka.
Lampiran
Jika Anda memiliki materi lain yang ingin ditautkan (misalnya, jika Anda membuat kontrak untuk bekerja dengan penulis teknis yang ingin Anda bagikan, atau template untuk project dokumentasi, atau referensi dokumentasi terbuka lainnya, Anda dapat mencantumkan dan menautkannya di sini). Lampiran juga merupakan tempat yang tepat untuk mencantumkan link ke alat atau referensi dokumentasi yang Anda gunakan, atau tempat untuk menambahkan ucapan terima kasih atau ucapan terima kasih yang mungkin tidak sesuai dengan bagian di atas.
Ucapan terima kasih
Tim kami ingin mengucapkan terima kasih kepada orang-orang dan hal-hal berikut:
- @Dillicious ingin berterima kasih kepada partnernya dan juga radio hip hop low-fi
- @KimChiCook ingin mengucapkan terima kasih kepadanya karena telah mengajarinya cara membuat acar
- @Piccalily ingin berterima kasih kepada Chicago Manual of Style Online
- @GherKen ingin berterima kasih kepada ketiga anaknya karena sudah memakan semua acar yang bisa dia buat
- @VinegarViv ingin berterima kasih kepada anggota tim lainnya karena telah mengakomodasi pengunduran dirinya
- @BBChips ingin mengucapkan terima kasih kepada makanan non-acar terbaik yang tersedia, Wafer Caramel Tunnock's
- @GloriousPilihlePat ingin berterima kasih kepada PickleDocs SIG karena telah menyelesaikan proyek ini
- Sam Scribe ingin berterima kasih kepada seluruh komunitas GloriousSelectle, tetapi terutama para Picklers yang mengirimi mereka stoples kaleng selama musim panas 2021 ketika stoples penuh, mereka memulai perjalanan mereka menuju banyak acar yang lezat.