Panduan penulis teknis

Tahap saat ini:
Hasil diumumkan linimasa.

Panduan ini ditujukan bagi penulis teknis yang tertarik untuk bekerja sama dengan organisasi yang diterima dalam program Season of Docs.

Apakah Anda harus berpartisipasi dalam program Season Dokumen?

Gunakan pertanyaan berikut untuk membantu memahami apakah Anda tertarik untuk bekerja sama dengan organisasi yang diterima dalam program Season Dokumen.

  • Apakah Anda memiliki keterampilan dan pengalaman teknis menulis? Season Dokumen tidak dimaksudkan untuk mengajarkan keterampilan dasar menulis teknis. Apakah Anda termotivasi dan terorganisir?
  • Apakah Anda memiliki waktu untuk berpartisipasi selama enam bulan dari program ini? 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, mengembangkan rentang waktu, menilai dan mengompilasi 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 Anda harus secara hukum dapat menerima dana untuk pekerjaan yang dilakukan di tempat tinggal Anda. Administrator program Season Dokumen tidak dapat memberikan saran pajak atau menjawab pertanyaan tentang kelayakan Anda untuk bekerja.

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

Berpartisipasi dalam program Season Dokumen sebagai penulis teknis

Fase eksplorasi

Pendaftaran organisasi ditutup pada 25 Maret 2022 pukul 18.00 UTC. Kami merekomendasikan agar penulis teknis mulai mengeksplorasi berbagai kemungkinan project secepat mungkin. Namun, organisasi dapat memilih penulis teknis yang akan diajak bekerja sama kapan saja sebelum 16 Mei 2022 pukul 18.00 UTC.

  • Temukan project yang menarik bagi Anda
    • Hubungi organisasi open source secara langsung menggunakan petunjuk di halaman program Season of Dokumen mereka, atau lihat Musim repositori GitHub Dokumen untuk menemukan organisasi yang telah menyatakan minatnya untuk berpartisipasi dalam Season Dokumen. Anda juga dapat menemukan organisasi yang tertarik di channel #season-of-docs dalam artikel Menulis Slack Dokumen.
    • Beberapa cara untuk memilih project:
      • Pilih project dalam bahasa yang Anda pahami atau minati, seperti JavaScript atau C.
      • Pilih project di bidang teknologi atau domain yang Anda minati, seperti machine learning, ilmu terbuka, atau robotika.
      • Pilih proyek berdasarkan keramahan komunitas! Hang out 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 untuk melamar!
  • Tinjau halaman proposal proyek
    • Setelah Anda memiliki 3-5 kemungkinan proyek, lihat halaman proposal setiap proyek
    • Anda harus mengajukan pertanyaan, memberikan umpan balik, dan membuat saran menggunakan saluran yang telah terdaftar dalam proyek untuk umpan balik dan diskusi
  • Kirimkan pernyataan minat 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 mutasi Anda.
    • Dengan mengirimkan pernyataan minat, Anda setuju untuk mematuhi kode etik organisasi dan kode etik Musim Dokumen.

Fase penerapan

  • Tunggu pengumuman organisasi yang diterima menurut Season Dokumen:
    • Organisasi yang diterima akan menghubungi secara langsung jika mereka ingin bekerja sama dengan Anda atau mendiskusikan pernyataan minat Anda lebih lanjut.
    • Organisasi tidak dibatasi untuk hanya bekerja sama dengan penulis teknis yang telah mengirimkan pernyataan minat sebelum batas waktu pendaftaran organisasi. Mereka dapat meminta pernyataan minat lebih lanjut setelah disetujui. Organisasi harus memilih penulis teknis sebelum 16 Mei 2022 pukul 18.00 UTC.
    • Organisasi tidak perlu memberikan masukan tentang pernyataan minat 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 sama dengan organisasi untuk memberikan informasi yang diperlukan untuk evaluasi akhir dan studi kasus.