Panduan penulis teknis

Fase saat ini:
Program Dokumen Season 2021 selesai pada 14 Desember 2021. Lihat linimasa.

Panduan ini ditujukan bagi penulis teknis yang tertarik bekerja sama dengan organisasi yang diterima dalam program Dokumen Musim 2021.

Haruskah Anda berpartisipasi dalam program Dokumen Musim 2021?

Gunakan pertanyaan berikut untuk membantu Anda memahami apakah Anda berminat bekerja sama dengan organisasi yang diterima dalam program Dokumen Musim 2021.

  • Apakah Anda memiliki keterampilan dan pengalaman menulis teknis? Season Dokumen tidak dimaksudkan untuk mengajarkan keterampilan menulis teknis dasar. Apakah Anda termotivasi dan terorganisir?
  • Apakah Anda memiliki waktu untuk berpartisipasi selama enam bulan program ini (April-November 2021)? Ukuran proyek bervariasi, tetapi berkisar dari komitmen 5-30 jam per minggu selama program berlangsung.
  • Apakah Anda tertarik untuk mendapatkan pengalaman bekerja di bidang {i>open source<i}? Apakah Anda bersedia meluangkan waktu untuk mempelajari proses proyek dan norma-norma komunitas?
  • Apakah Anda bersedia bekerja dengan administrator organisasi untuk menyempurnakan proposal proyek mereka, mengembangkan jadwal, menilai dan menyusun metrik, dan membantu organisasi secara keseluruhan memahami nilai penulisan teknis?

Anda juga harus memenuhi persyaratan kelayakan program, termasuk dapat membuat akun Open Collective. Perhatikan bahwa secara hukum Anda harus secara hukum dapat menerima dana untuk pekerjaan yang dilakukan di tempat tinggal Anda. Administrator program Season of Dokumen tidak dapat memberikan saran pajak atau menjawab pertanyaan tentang kelayakan pekerjaan Anda.

Sebagai penulis teknis terampil yang berpartisipasi dalam Season of Docs, Anda akan dibayar untuk mendapatkan pengalaman bekerja di open source sementara Anda membantu proyek Anda memenuhi kebutuhan utama melalui dokumen yang lebih baik.

Berpartisipasi dalam program Dokumen Musim 2021 sebagai penulis teknis

Fase eksplorasi

Pendaftaran organisasi ditutup pada 26 Maret 2021 pukul 18.00 UTC. Sebaiknya penulis teknis mulai mengeksplorasi kemungkinan project sedini mungkin. Namun, organisasi dapat memilih penulis teknis untuk diajak bekerja sama kapan saja sebelum 17 Mei 2021 pukul 18.00 UTC.

  • Temukan proyek yang Anda minati
    • Hubungi langsung organisasi open source menggunakan petunjuk di halaman program Season of Dokumen mereka, atau lihat Repositori GitHub Season Dokumen untuk menemukan organisasi yang telah menyatakan minat untuk berpartisipasi dalam Season of Dokumen. Anda juga dapat menemukan organisasi yang tertarik di channel #season-of-docs di artikel Menulis Dokumen Slack.
    • Beberapa cara untuk memilih project:
      • Pilih project dalam bahasa yang Anda kuasai atau minati, seperti JavaScript atau C.
      • Pilih project dalam teknologi atau domain yang Anda minati, seperti machine learning, sains terbuka, atau robotika.
      • Pilih proyek berdasarkan keramahan komunitas. Bergaul di forum diskusi mereka, lihat akun media sosial kontributor (jika mereka membicarakan proyek mereka di sana), dan lihat dokumentasi orientasi mereka, jika ada.
      • Jika ada proyek yang ingin Anda kerjakan yang tidak ada dalam daftar proyek, hubungi proyek itu dan minta mereka untuk mempertimbangkan melamar!
  • Tinjau halaman proposal proyek
    • Setelah Anda memiliki 3-5 kemungkinan proyek, lihat setiap halaman proposal proyek
    • Anda harus mengajukan pertanyaan, memberikan umpan balik, dan membuat saran menggunakan saluran yang telah dicantumkan dalam proyek untuk umpan balik dan diskusi
  • Kirimkan pernyataan kepentingan secara langsung ke organisasi. Dalam pernyataan minat, Anda akan menunjukkan bagaimana Anda akan mencapai tujuan yang ditetapkan dalam proposal proyek organisasi.
    • Gunakan template pernyataan minat Season Dokumen. Lebih pendek lebih baik!
    • Gunakan petunjuk di halaman ide organisasi untuk mengirimkan pernyataan minat Anda. Jika organisasi telah mencantumkan persyaratan khusus, pastikan Anda menunjukkan bahwa Anda memenuhi persyaratan tersebut dalam laporan.
    • Dengan mengirimkan pernyataan minat, Anda setuju untuk mematuhi kode etik organisasi dan kode etik Musim Dokumen.

Fase pendaftaran

  • Tunggu pengumuman organisasi yang diterima berdasarkan Season Dokumen:
    • Organisasi yang diterima akan menghubungi Anda secara langsung jika ingin bekerja sama dengan Anda atau mendiskusikan pernyataan minat Anda lebih lanjut.
    • Organisasi tidak hanya dapat bekerja sama dengan penulis teknis yang telah mengirimkan pernyataan minat hingga batas waktu pendaftaran organisasi. Studi kegunaan dapat meminta pernyataan kepentingan lebih lanjut setelah persetujuan. Organisasi harus memilih penulis teknis sebelum 17 Mei 2021 pukul 18.00 UTC.
    • Organisasi tidak perlu memberikan masukan tentang pernyataan kepentingan yang gagal.

Fase pengembangan proyek

  • Bekerja samalah dengan organisasi untuk membuat jadwal, termasuk hasil kerja dan tenggat waktu.

Fase evaluasi akhir dan studi kasus

  • Bekerja samalah dengan organisasi untuk memberikan informasi yang diperlukan bagi evaluasi akhir dan studi kasus.