Ide project

Fase saat ini:
Hasil diumumkan. Lihat linimasa.

Halaman ini ditujukan untuk organisasi open source yang berada dalam fase eksplorasi 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 disertakan dalam daftar ini.

Ide Project: membuat panduan orientasi kontributor

Masalah

  • Kontributor baru tidak dapat menemukan informasi penyiapan yang mereka perlukan untuk memberikan kontribusi yang berarti pada project kami. Beberapa proses (seperti berkontribusi pada pengujian kami) tidak didokumentasikan sama sekali.

Bagaimana cara mengukur kesuksesan?

  • Peningkatan jumlah kontributor baru
  • Peningkatan jumlah kontributor non-kode baru (dengan mempermudah kontribusi ke dokumen atau pengujian)
  • Penurunan jumlah masalah yang dilaporkan oleh kontributor baru
  • Peningkatan jumlah masalah yang ditutup dan diberi tag “good first issue”

Keterampilan apa yang diperlukan penulis teknis untuk mengerjakan project ini?

  • Wajib memiliki: Pemahaman tentang GitHub (atau kesediaan untuk mempelajari tutorial GitHub)
  • Opsional: Memahami runner pengujian, untuk menjalankan pengujian dan memperbarui dokumentasi untuk melakukannya

Volunteer

Dorong anggota komunitas untuk mendaftar guna membantu menyelesaikan 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 project ini harus mengirim email ke email@project. Harap sertakan tautan ke pekerjaan penulisan teknis atau portofolio/resume/CV.

Project Idea: write tutorials to use our library with ...

Masalah

  • Project kami mendapatkan banyak masalah oleh pengguna yang mencoba menggunakan library kami dengan $TechnologyX. Kami tidak memiliki panduan yang jelas untuk berintegrasi dengan $TechnologyX dan prosesnya bisa jadi rumit.

Bagaimana cara mengukur kesuksesan?

  • Penurunan jumlah masalah yang diberi tag "$TechnologyX"
  • Peningkatan jumlah permintaan pull dari kontributor baru untuk membantu kami memperbaiki bug atau menambah dokumentasi seputar $TechnologyX
  • Link lainnya ke project kami dari project $TechnologyX

Keterampilan apa yang diperlukan penulis teknis untuk mengerjakan project ini?

  • Opsional: Beberapa pengetahuan tentang $TechnologyX

Volunteer

Dorong anggota komunitas untuk mendaftar guna membantu menyelesaikan tugas tertentu, misalnya:

  • @JaneQDev, dapat membantu menjawab pertanyaan tentang $TechnologyX
  • @ChenPCoder, dengan senang hati meninjau permintaan pull dokumen

Info kontak

  • Penulis teknis yang tertarik untuk mengerjakan project ini harus mengirim email ke email@project. Sertakan link ke karya penulisan teknis atau portofolio/resume/CV Anda.

Ide Project: mengatur ulang dokumentasi

Masalah

  • Dokumentasi kami luas dan tidak teratur. Banyak pengguna menyerah mencoba menemukan jawaban dalam dokumentasi dan hanya mengajukan masalah atau bertanya di forum kami. Halaman kami tidak muncul di hasil penelusuran bahkan untuk kata kunci yang relevan.

Bagaimana cara mengukur kesuksesan?

  • SEO yang lebih baik untuk dokumentasi kami
  • Penurunan jumlah masalah yang dilaporkan untuk topik yang dibahas dalam dokumentasi
  • Peningkatan jumlah kontribusi dokumentasi

Keterampilan apa yang diperlukan penulis teknis untuk mengerjakan project ini?

  • Mudah dimiliki: pengalaman mengatur ulang kumpulan dokumentasi yang besar dan matang, pemahaman tentang SEO

Volunteer

Mendorong anggota komunitas untuk mendaftar guna membantu tugas tertentu, misalnya:

  • @ChenPCoder, dengan senang hati akan meninjau permintaan pull dokumen

Info kontak

  • Penulis teknis yang tertarik untuk mengerjakan project ini harus mengirim email ke email@project. Sertakan link ke karya penulisan teknis atau portofolio/resume/CV Anda.

Project Idea: menjalankan perbaikan dokumentasi

Masalah

  • Kami memiliki banyak bug kecil dan masalah lama yang terkait dengan dokumentasi kami. Komunitas kami akan dengan senang hati membantu membersihkannya, tetapi kami memerlukan seseorang untuk mengatur dan menjalankan perbaikan yang sebenarnya.

Bagaimana cara mengukur kesuksesan?

  • Jumlah masalah terkait dokumentasi yang ditutup
  • Peningkatan jumlah kontribusi dokumentasi dan kontributor baru

Keterampilan apa yang diperlukan seorang penulis teknis untuk mengerjakan project ini?

  • Opsional: pengalaman menjalankan perbaikan dokumentasi
  • Keterampilan organisasi yang baik

Volunteer

Dorong anggota komunitas untuk mendaftar guna membantu menyelesaikan tugas tertentu, misalnya:

  • @ChenPCoder, dapat membantu mengatur video dan chat untuk fixit serta membantu menemukan sukarelawan di zona waktu lain

Info kontak

  • Penulis teknis yang tertarik untuk mengerjakan project ini harus mengirim email ke email@project/membuka masalah/bertanya di forum kami. Sertakan link ke pekerjaan penulisan teknis atau portofolio/resume/CV Anda.

Ide Project: melakukan audit dokumentasi

Masalah

  • Kita tidak memiliki gambaran yang jelas tentang status dokumentasi kita. Sulit untuk memprioritaskan peningkatan dokumentasi karena kita tidak memiliki roadmap atau gambaran tentang masalah yang paling mendesak. Kami juga memiliki banyak konten yang sudah tidak berlaku dan harus dihapus atau diarsipkan.

Bagaimana cara mengukur kesuksesan?

  • Pembuatan roadmap dokumentasi dengan persetujuan umum dari komunitas
  • Penurunan jumlah halaman dokumentasi yang usang atau salah

Keterampilan apa yang diperlukan seorang penulis teknis untuk mengerjakan project ini?

  • Opsional: pengalaman melakukan audit dokumen

Volunteer

Dorong anggota komunitas untuk mendaftar guna membantu menyelesaikan tugas tertentu, misalnya:

  • @JaneQCoder, dapat membantu mengoordinasikan presentasi roadmap dokumentasi dalam pertemuan komunitas kami

Info kontak

  • Penulis teknis yang tertarik untuk mengerjakan project ini harus mengirim email ke email@project/membuka masalah/bertanya di forum kami. Sertakan link ke pekerjaan penulisan teknis atau portofolio/resume/CV Anda.