Fase saat ini:
Hasil diumumkan. Lihat
linimasa.
Halaman ini ditujukan untuk organisasi open source dalam fase eksplorasi dalam proses pengajuan permohonan organisasi. Ide project ini hanyalah contoh untuk menunjukkan cara organisasi mendeskripsikan kemungkinan project dokumentasi di halaman ide project organisasi; organisasi dapat mengusulkan project yang tidak termasuk dalam daftar ini.
Ide Proyek: membuat panduan orientasi kontributor
Permasalahan
- Kontributor baru tidak dapat menemukan informasi penyiapan yang dibutuhkan untuk memberikan kontribusi yang berarti bagi project kita. Beberapa proses (misalnya, berkontribusi terhadap pengujian) sama sekali tidak didokumentasikan.
Bagaimana cara kami mengukur keberhasilan?
- Peningkatan jumlah kontributor baru
- Peningkatan jumlah kontributor non-kode baru (dengan mempermudah kontribusi ke dokumen atau pengujian)
- Mengurangi jumlah masalah yang diajukan oleh kontributor baru
- Peningkatan jumlah masalah tertutup yang diberi tag “masalah pertama yang baik”
Keterampilan apa yang dibutuhkan seorang penulis teknis untuk mengerjakan project ini?
- Harus memiliki: Pemahaman tentang GitHub (atau kesediaan untuk bekerja melalui tutorial GitHub)
- Opsional: Memahami runner pengujian kami, untuk menjalankan pengujian dan memperbarui dokumentasi untuk melakukannya
Relawan
Dorong anggota komunitas untuk mendaftar guna membantu melakukan tugas tertentu, misalnya:
- @JaneQDev, dapat membantu menjawab pertanyaan tentang pengujian kami
- @ChenPCoder, dengan senang hati akan meninjau permintaan pull dokumen
- @ErichJEngineer, dapat memandu proses kontribusi saat ini bersama penulis teknis
Info kontak
- Penulis teknis yang tertarik untuk mengerjakan proyek ini harus mengirim email ke email@project. Harap sertakan link ke tugas penulisan teknis atau portofolio/résumé/CV.
Ide Proyek: tulis tutorial untuk menggunakan library kami dengan ...
Permasalahan
- Project kita mendapat banyak masalah yang dikemukakan oleh pengguna yang mencoba menggunakan library kita dengan $TechnologyX. Kami tidak memiliki panduan yang jelas untuk berintegrasi dengan $TechnologyX dan hal itu bisa menjadi rumit.
Bagaimana cara kami mengukur keberhasilan?
- Penurunan jumlah masalah dengan tag "$TechnologyX"
- Peningkatan jumlah permintaan pull dari kontributor baru yang membantu kami memperbaiki bug atau menambahkan ke dokumentasi terkait $TechnologyX
- Link lainnya ke project kami dari project $TechnologyX
Keterampilan apa yang dibutuhkan seorang penulis teknis untuk mengerjakan project ini?
- Opsional: Perlu pengetahuan tentang $technologiesX
Relawan
Dorong anggota komunitas untuk mendaftar guna membantu melakukan tugas tertentu, misalnya:
- @JaneQDev, dapat membantu menjawab pertanyaan tentang $TechnologyX
- @ChenPCoder, dengan senang hati akan meninjau permintaan pull dokumen
Info kontak
- Penulis teknis yang tertarik untuk mengerjakan proyek ini harus mengirim email ke email@project. Sertakan link ke karya penulisan teknis atau portofolio/resume/CV Anda.
Ide Proyek: menata ulang dokumentasi
Permasalahan
- Dokumentasi kami terlalu banyak dan tidak teratur. Banyak pengguna yang menyerah mencoba menemukan jawaban dalam dokumentasi dan hanya mengajukan masalah atau mengajukan pertanyaan di forum kami. Halaman kita tidak akan muncul di hasil penelusuran bahkan untuk kata kunci yang relevan.
Bagaimana cara kami mengukur keberhasilan?
- SEO yang lebih baik untuk dokumentasi kami
- Penurunan jumlah masalah yang diangkat untuk topik yang dibahas dalam dokumentasi
- Peningkatan jumlah kontribusi dokumentasi
Keterampilan apa yang dibutuhkan seorang penulis teknis untuk mengerjakan project ini?
- Opsional: berpengalaman dalam mengatur ulang kumpulan dokumentasi yang besar dan matang, serta memahami SEO
Relawan
Dorong anggota komunitas untuk mendaftar guna membantu melakukan tugas tertentu, misalnya:
- @ChenPCoder, dengan senang hati akan meninjau permintaan pull dokumen
Info kontak
- Penulis teknis yang tertarik untuk mengerjakan proyek ini harus mengirim email ke email@project. Sertakan link ke karya penulisan teknis atau portofolio/resume/CV Anda.
Ide Proyek: menjalankan perbaikan dokumentasi
Permasalahan
- Kami memiliki banyak {i>bug<i} dan masalah lama terkait dengan dokumentasi kami. Komunitas kami akan dengan senang hati ikut serta dan membantu membereskan masalah, tetapi kami membutuhkan seseorang untuk mengatur dan menjalankan perbaikan yang sebenarnya.
Bagaimana cara kami mengukur keberhasilan?
- Jumlah masalah terkait dokumentasi yang ditutup
- Peningkatan jumlah kontribusi dokumentasi dan kontributor baru
Keterampilan apa yang dibutuhkan seorang penulis teknis untuk mengerjakan project ini?
- Bagus untuk dimiliki: pengalaman menjalankan perbaikan dokumentasi
- Keterampilan organisasi yang hebat
Relawan
Dorong anggota komunitas untuk mendaftar guna membantu melakukan tugas tertentu, misalnya:
- @ChenPCoder, dapat membantu mengatur video dan chat untuk {i>fixit<i} dan membantu menemukan sukarelawan di zona waktu lain
Info kontak
- Penulis teknis yang tertarik untuk mengerjakan project ini dapat mengirim email ke email@project/membuka masalah/bertanya di forum kami. Harap sertakan link ke karya penulisan teknis atau portofolio/resume/CV Anda.
Ide Proyek: lakukan audit dokumentasi
Permasalahan
- Kami kurang paham dengan status dokumentasi kami. Peningkatan kualitas dokumentasi sulit diprioritaskan karena kami tidak memiliki roadmap atau pemahaman tentang masalah yang paling mendesak. Kami juga memiliki banyak konten usang yang harus dihapus atau diarsipkan.
Bagaimana cara kami mengukur keberhasilan?
- Pembuatan roadmap dokumentasi dengan persetujuan umum dari komunitas
- Penurunan jumlah halaman dokumentasi yang usang atau salah
Keterampilan apa yang dibutuhkan seorang penulis teknis untuk mengerjakan project ini?
- Opsional: pengalaman melakukan audit dokumen
Relawan
Dorong anggota komunitas untuk mendaftar guna membantu melakukan tugas tertentu, misalnya:
- @JaneQCoder, dapat membantu mengoordinasikan presentasi roadmap dokumentasi dalam rapat komunitas kami
Info kontak
- Penulis teknis yang tertarik untuk mengerjakan project ini dapat mengirim email ke email@project/membuka masalah/bertanya di forum kami. Harap sertakan link ke karya penulisan teknis atau portofolio/resume/CV Anda.
Informasi terkait
- Halaman promosi dan pers menyertakan logo dan konten lainnya yang dapat Anda gunakan saat membahas Google Season Dokumen.
- Video dari PyCon Australia 2017 ini memberikan petunjuk tentang cara mengatur dokumentasi Anda agar orang-orang dapat merasakan manfaatnya: What nobody bercerita tentang dokumentasi oleh Daniele Procida.