Ide project

Fase saat ini:
Program Dokumen Musim 2020 selesai pada 15 Maret 2021. Lihat linimasa.

Ide project adalah saran dari organisasi open source untuk project yang dapat diselesaikan oleh penulis teknis melalui kerja sama dengan mentor selama Season Dokumen.

Informasi di halaman ini ditujukan untuk administrator dan mentor organisasi open source yang sedang menyiapkan daftar ide project. Informasi ini juga berguna bagi penulis teknis sebagai latar belakang partisipasi organisasi dalam Season Dokumen.

Contoh project

Di bawah ini adalah beberapa ide tentang jenis proyek yang dapat ditangani oleh penulis teknis:

  • Buat situs dokumentasi di sebuah platform yang akan diputuskan oleh penulis teknis dan mentor open source, serta publikasikan kumpulan dokumen dasar awal di situs tersebut. Contoh platform meliputi:

  • Faktorkan ulang dokumentasi project open source yang ada untuk memberikan pengalaman pengguna yang lebih baik atau arsitektur informasi yang lebih mudah diakses.

  • Tulis ikhtisar konseptual tentang, atau pengantar, produk atau fitur. Sering kali tim membuat dokumentasi teknis dari bawah ke atas, sehingga ada banyak detail, tetapi sulit untuk memahami produk secara keseluruhan. Penulis teknis dapat memperbaikinya.

  • Buat tutorial untuk kasus penggunaan penting.

  • Buat serangkaian panduan cara kerja yang terfokus untuk tugas tertentu.

  • Buat panduan kontributor yang berisi informasi dasar tentang cara memulai sebagai kontributor project open source, serta aturan apa pun seputar perjanjian lisensi, proses permintaan pull dan peninjauan, pembuatan project, dan sebagainya.

Ide-ide di atas sengaja bervariasi dalam cakupan dan ukuran. Durasi waktu yang dibutuhkan suatu project bergantung pada sejumlah faktor, termasuk ukuran set dokumentasi, kompleksitas produk, pengalaman penulis teknis dan mentor open source, alat dan proses yang ditawarkan oleh project open source, dan banyak lagi.

Tujuan daftar di atas adalah untuk membantu Anda memulai. Anda juga dapat mengusulkan jenis proyek lainnya.

Memublikasikan daftar ide proyek Anda

Anda harus memublikasikan ide project di halaman web publik, di postingan blog, atau di beberapa dokumen lainnya yang terlihat secara publik.

Halaman ide proyek Anda harus mencakup:

  • Informasi tentang organisasi open source Anda:

    • Nama organisasi.
    • Deskripsi organisasi.
    • Link ke repositori dan/atau situs open source Anda.
    • (Opsional) Alamat email untuk menghubungi organisasi Anda terkait Season Dokumen. Alamat email ini harus sama dengan alamat email yang Anda sertakan di formulir permohonan organisasi untuk Season Dokumen.
    • (Opsional) Informasi tentang administrasi dan mentor organisasi Anda, seperti nama tampilan mereka. Nama ini harus sama dengan nama tampilan yang Anda sertakan di formulir permohonan organisasi untuk Season Dokumen.

  • Pengumuman bahwa organisasi Anda mendaftar untuk berpartisipasi dalam Musim Dokumen tahun ini. Halaman promosi dan pers menyertakan logo dan konten lainnya yang dapat Anda gunakan saat membahas Season Dokumen.

  • Ide project Anda, termasuk informasi yang dijelaskan di bawah untuk setiap ide project.

Saat membuat aplikasi organisasi untuk Season of Docs, Anda harus menyertakan link ke halaman ide project.

Informasi di setiap ide proyek

Setiap ide proyek harus menyertakan setidaknya informasi berikut:

  • Nama project: Pilih judul yang ringkas namun deskriptif.
  • Deskripsi: Deskripsi yang lebih panjang dari pekerjaan dokumentasi yang diperlukan. Jelaskan ide awal Anda secara rinci. Menawarkan kesempatan bagi penulis teknis yang tertarik untuk memperluas atau menyempurnakan ide.

  • Materi terkait:

    • Tautkan ke proyek open source yang membutuhkan dokumentasi.
    • Jika Anda mengusulkan proyek penulisan teknis yang melibatkan pembaruan pada kumpulan dokumentasi yang ada, berikan tautan ke kumpulan dokumentasi tersebut.
    • Jika Anda mengusulkan tutorial atau serangkaian panduan cara kerja, jelaskan fitur atau kasus penggunaan yang perlu didokumentasikan.
    • Jika Anda mengusulkan panduan kontributor, berikan link ke file README yang sudah ada atau materi lain yang relevan jika ada. Jika belum ada yang tersedia, tidak masalah untuk mengatakannya.
    • Sertakan link ke dokumentasi serupa di project lain, jika relevan.

Pentingnya ide-ide proyek

Ide-ide proyek Anda penting dalam beberapa hal:

  • Bekerja berdasarkan ide membantu organisasi Anda merumuskan tugas dokumentasi yang diperlukan dan mempersiapkan diri untuk bekerja sama dengan penulis teknis.
  • Ide project memberi administrator program Google indikasi tentang jenis pekerjaan yang akan ditangani penulis teknis saat mereka memasuki hubungan bimbingan dengan organisasi Anda. Administrator program Google menggunakan ide project untuk menilai komitmen organisasi terhadap partisipasi dalam Season of Docs dan membimbing seorang penulis teknis di seluruh program.
  • Ide-ide proyek menarik penulis teknis yang tertarik ke organisasi Anda. Mereka dapat menggunakan project yang Anda sarankan sebagai dasar untuk proposal project mereka sendiri.
  • Halaman promosi dan pers menyertakan logo dan konten lainnya yang dapat Anda gunakan saat membahas 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.