Panduan penulis teknis

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

Halaman ini berisi panduan untuk penulis teknis yang berpartisipasi dalam Season Dokumen.

Pengantar

Selamat datang di Season Dokumen! Panduan ini menjelaskan sedikit tentang partisipasi Anda dalam Season Dokumen dan membantu aktivitas yang harus Anda lakukan di setiap fase program.

Kelayakan untuk berpartisipasi dalam Season Dokumen

Untuk berpartisipasi dalam Season Dokumen sebagai penulis teknis, Anda harus:

  • Berusia minimal 18 tahun saat mendaftar.
  • Mampu mendemonstrasikan pengalaman penulisan teknis sebelumnya dengan mengirimkan deskripsi peran dan sampel pekerjaan.
  • Memenuhi syarat untuk bekerja di negara tempat tinggalnya selama durasi program.
  • Penduduk suatu negara yang saat ini tidak diembargo oleh Amerika Serikat. Lihat Program Sanksi dan Informasi Negara dari Departemen Keuangan AS.

Lihat istilah penulis teknis selengkapnya.

Mentor open source Anda

Musim mentor Dokumen tidak selalu berupa penulis teknis, dan mereka mungkin memiliki sedikit pengalaman dalam komunikasi teknis. Mereka adalah anggota organisasi open source yang mengetahui nilai dokumentasi yang baik serta berpengalaman dalam proses dan alat open source.

Hubungan antara Anda dan mentor Anda adalah sebuah kolaborasi. Anda menghadirkan pengalaman dan keterampilan dokumentasi ke organisasi {i>open source<i}. Para mentor Anda menyumbangkan pengetahuannya tentang open source dan kode. Anda dapat bersama-sama mengembangkan dokumentasi teknis dan meningkatkan proses project open source.

Fase pengumuman program dan pendaftaran organisasi

Tanggal pengumuman untuk Season Dokumen adalah 23 Maret 2020. Organisasi open source yang tertarik dapat mendaftar untuk berpartisipasi dalam Season Dokumen antara 13 April 2020 dan 4 Mei 2020. Administrator program Google memublikasikan daftar organisasi yang berhasil pada 11 Mei 2020.

Selama periode antara pengumuman program dan publikasi organisasi open source yang berpartisipasi, ada baiknya Anda terus memantau berita. Anda dapat kembali ke situs ini, dan juga menonton postingan blog atau berita lainnya di Web. Beberapa organisasi open source dapat membagikan ide mereka bahkan selama fase pengajuan permohonan organisasi.

Kami juga mengundang Anda untuk mempromosikan Season Dokumen dan alasan mengapa Anda tertarik dengan program ini. Lihat materi promosi untuk mendapatkan grafis dan ide.

Fase eksplorasi penulis teknis

Fase eksplorasi penulis teknis berlangsung dari 11 Mei - 8 Juni 2020. Selama periode ini, Anda dapat menjelajahi daftar organisasi yang berpartisipasi beserta ide proyek mereka. Ini adalah kesempatan terbuka bagi penulis teknis -- Anda tidak perlu persetujuan dari Season Dokumen untuk memulai. Namun, perhatikan persyaratan kelayakan di atas.

Saat menemukan satu atau beberapa project yang menarik bagi Anda, Anda harus mendekati organisasi open source yang relevan secara langsung untuk mendiskusikan ide project.

Tugas Anda sebagai penulis teknis selama fase ini

Pelajari daftar organisasi open source yang berpartisipasi dan berbagai ide project mereka.

Periksa daftar untuk menemukan organisasi open source yang ingin Anda ajak bekerja sama. Lihat project penulisan teknis yang telah diusulkan organisasi dan tentukan project yang cocok untuk Anda. Anda dapat mendaftar ke lebih dari satu organisasi. Pada tahap Season Dokumen ini, sebaiknya pelajari lebih dari satu opsi. Proses pemilihan akhir hanya menerima satu project per penulis teknis.

Organisasi open source yang berpartisipasi

Diskusikan ide proyek dengan organisasi {i>open source<i}.

Anda dapat mendiskusikan ide project dengan organisasi yang berpartisipasi. Untuk melakukan kontak, gunakan alamat email organisasi yang ditampilkan dalam daftar organisasi yang berpartisipasi. Diskusi awal membantu Anda membuat proposal project yang bagus untuk dikirimkan kepada administrator program Google selama fase pendaftaran penulis teknis. Ide project awal mungkin berasal dari daftar ide yang diusulkan organisasi. Anda juga dapat mengusulkan ide Anda sendiri.

Organisasi open source yang berpartisipasi

Ide untuk project penulisan teknis

Fase pendaftaran penulis teknis

Fase pendaftaran penulis teknis berlangsung dari 9 Juni 2020 - 9 Juli 2020. Selama periode ini, Anda dapat mendaftar untuk berpartisipasi dalam Season Dokumen. Administrator program Google meneruskan detail yang relevan dari aplikasi Anda ke organisasi open source yang Anda pilih. Administrator dan mentor organisasi open source kemudian memilih project yang ingin mereka bimbing.

Tugas Anda sebagai pelamar penulis teknis selama fase ini

Kirim permohonan untuk berpartisipasi dalam Season Dokumen.

Kirimkan permohonan Anda untuk Season Dokumen sebelum 9 Juli 2020.

Membuat aplikasi Anda

Aplikasi penulis teknis Dokumen Musim 2020 kini ditutup. Bergabunglah dengan milis pengumuman di season-of-docs-announce untuk mendapatkan informasi terbaru.

Fase ikatan komunitas

Tahap kerja sama komunitas ini berlangsung dari 17 Agustus - 13 September 2020. Selama periode ini, mentor open source membantu Anda membiasakan diri dengan komunitas dan project open source.

Tugas Anda sebagai penulis teknis selama fase ini

Menyiapkan saluran komunikasi.

Hubungi mentor Anda di organisasi open source yang telah dipilih untuk bekerja sama dengan Anda. Pastikan Anda memiliki cara yang andal untuk berkomunikasi langsung dengan mentor dan administrator organisasi—yang terakhir adalah anggota organisasi open source yang bertindak sebagai kontak Musim Dokumen utama untuk organisasi mereka.

Tanggung jawab Anda

Tanggung jawab mentor Anda

Panduan mentor untuk bekerja sama dengan penulis teknis

Terlibat dalam proyek dan komunitas open source.

Ajukan pertanyaan kepada mentor Anda tentang alat dan proses yang digunakan organisasi open source. Perkenalkan diri Anda di milis, chat, saluran Slack, dan saluran komunikasi bersama komunitas open source lainnya.

Mendapatkan pemahaman tentang produk secara keseluruhan.

Minta mentor Anda menjelaskan produk (terutama secara konseptual) yang akan segera Anda dokumentasikan. Diskusikan audiens dokumentasi ini secara mendetail.

Tetapkan tujuan dan ekspektasi.

Bekerja samalah dengan mentor Anda untuk menyempurnakan sasaran proyek penulisan teknis dan menetapkan ekspektasi di kedua sisi. Menetapkan tujuan dan ekspektasi ini sekarang adalah cara yang baik untuk memastikan keberhasilan project Anda.

Tahap pengembangan dokumen

Tahap pengembangan dokumen berlangsung dari 14 September 2020 - 30 November 2020. (Tanggal akhir berbeda untuk project yang berjalan lama.) Selama periode ini, Anda mengerjakan proyek Anda dengan konsultasi ketat dengan para mentor.

Tugas Anda sebagai penulis teknis selama fase ini

Bekerja samalah dengan mentor Anda untuk menyelesaikan proyek Anda.

Bekerja samalah dengan mentor Anda untuk menyelesaikan proyek Anda. Ikuti prosedur komunitas open source untuk meminta peninjauan atas dokumentasi yang dihasilkan dan mengirimkan update ke repositori open source. Misalnya, project open source yang dihosting di GitHub menambahkan atau mengupdate file dengan membuat permintaan pull untuk ditinjau dan dikirim.

Sampaikan masalah apa pun kepada administrator organisasi.

Jika Anda memiliki masalah terkait komunikasi dengan mentor atau mengalami masalah lain yang dapat memengaruhi keberhasilan penyelesaian project, beri tahu administrator organisasi open source.

Tanggung jawab Anda

Isi survei apa pun dari administrator program Google.

Administrator program Google dapat mengirimkan survei di tengah project untuk menilai progres. Isi survei dan kirimkan jawaban Anda kepada administrator program Google sesuai petunjuk pada dokumen survei.

Fase finalisasi dan evaluasi proyek

Tahap finalisasi proyek berlangsung dari 30 November - 5 Desember 2020, dan fase evaluasi berlangsung dari 3 - 10 Desember 2020. (Tanggalnya berbeda untuk project yang berjalan lama.) Selama periode finalisasi proyek, Anda mengirimkan laporan proyek, yang juga disebut produk kerja akhir Anda. Selama fase evaluasi, kirim evaluasi terhadap mentor dan pengalaman Anda sebagai peserta dalam Season Dokumen.

Tugas Anda sebagai penulis teknis selama fase ini

Tulis laporan proyek Anda.

Tulis laporan project Anda (terkadang disebut produk kerja). Laporan project menyertakan deskripsi pekerjaan yang telah Anda lakukan selama Musim Dokumen dan semua link yang relevan.

Membuat laporan project

Fase finalisasi project yang berjalan lama telah ditutup.

Minta mentor Anda untuk meninjau laporan proyek Anda.

Mentor Anda mungkin memiliki insight berharga tentang cara menggambarkan pencapaian Anda. Selain itu, pemahaman bersama tentang status proyek akan berguna pada tahap ini, sebelum mentor Anda menandai proyek sebagai berhasil diselesaikan atau tidak.

Selesaikan laporan proyek Anda.

Selesaikan laporan project Anda paling lambat tanggal 8 Maret 2021 pukul 18.00 UTC. Formulir ini dapat diedit, tetapi Anda harus mengirimkan versi final paling lambat pada tanggal yang ditentukan.

Fase finalisasi project yang berjalan lama telah ditutup.

Tulis dan kirimkan evaluasi Anda terhadap mentor dan pengalaman Anda dalam menggunakan Season Dokumen.

Selesaikan dan kirimkan evaluasi paling lambat 12 Maret 2021 pukul 18.00 UTC.

Evaluasi oleh penulis teknis

Tanggung jawab Anda

Fase evaluasi project yang berjalan lama telah ditutup.

Project yang berjalan lama

Untuk project penulisan teknis berdurasi standar di Season Dokumen, fase pengembangan dokumen berlangsung dari 14 September 2020 - 30 November 2020. Namun, beberapa penulis teknis dapat mengajukan permohonan untuk project yang berjalan lama berdasarkan konsultasi dengan organisasi open source. Untuk project yang berjalan lama, fase pengembangan dokumen berlangsung dari 14 September 2020 - 1 Maret 2021.

Periode finalisasi dan evaluasi project untuk project yang berjalan lama adalah 1 - 8 Maret 2021.

Tugas dan tanggung jawab Anda sama seperti yang dijelaskan di halaman ini untuk project penulisan teknis berdurasi standar, kecuali bahwa tanggal finalisasi dan evaluasi project jatuh kemudian.