Membuat aplikasi penulisan teknis

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

Halaman ini berisi petunjuk bagi penulis teknis tentang cara menyelesaikan bagian penting dari aplikasi untuk berpartisipasi dalam Season Dokumen. Informasi ini membantu Anda memahami faktor apa saja yang dapat dipertimbangkan oleh organisasi open source saat memilih proyek penulisan teknis yang ingin mereka bimbing selama Musim Dokumen.

Pengantar

Pedoman di bawah berlaku secara umum untuk Season Dokumen. Setiap organisasi {i>open source<i} dapat memiliki kriteria penilaian tertentu. Anda dapat menghubungi organisasi yang berpartisipasi sebelum mengirimkan permohonan, untuk mendiskusikan persyaratan mereka dan merencanakan proposal proyek Anda. Lihat fase eksplorasi penulis teknis yang dijelaskan dalam panduan penulis teknis.

Formulir permohonan

Formulir permohonan tersedia di panduan penulis teknis selama fase pendaftaran penulis teknis.

Setelah mengirimkan formulir, Anda dapat terus memperbarui informasi di formulir tersebut hingga fase pendaftaran penulis teknis berakhir (9 Juli 2020).

Informasi pribadi

Formulir permohonan meminta informasi pribadi berikut:

  • Nama Anda: Masukkan nama lengkap Anda. Season Dokumen tidak akan membagikan nama ini dengan organisasi open source dan tidak akan memublikasikan nama ini di situs.

  • Nama tampilan pilihan Anda: Berikan nama yang ingin Anda gunakan sebagai ID publik selama partisipasi Anda dalam Season Dokumen. Sebaiknya Anda jangan menggunakan nama lengkap asli untuk nama tampilan Anda. Season Dokumen akan membagikan nama tampilan Anda kepada organisasi open source yang Anda tentukan di formulir permohonan. Season Dokumen akan memublikasikan nama tampilan Anda di situs dalam daftar project penulisan teknis yang diterima.

  • Alamat email Anda: Berikan alamat email yang terkait dengan Akun Google Anda. (Anda memerlukan Akun Google untuk berpartisipasi dalam Season Dokumen. Anda dapat menggunakan alamat email non-Gmail dengan Akun Google. Lihat artikel bantuan ini.) Season Dokumen menggunakan alamat email Anda untuk berkomunikasi dengan Anda dan menyediakan resource situs untuk Anda. Season Dokumen akan membagikan alamat email ini dengan organisasi open source yang Anda tentukan dalam formulir permohonan. Season Dokumen tidak akan memublikasikan alamat email ini di situs.

Lihat di bawah untuk mengetahui ringkasan cara Season Dokumen menggunakan informasi dari formulir permohonan Anda.

Informasi tentang pengalaman penulisan teknis Anda

Ketika mentor {i>open source<i} dan administrator organisasi memeriksa proposal proyek, mereka tertarik dengan pengalaman menulis teknis Anda. Anda dapat memberikan detail formulir sebagai berikut:

  • Pengalaman penulisan teknis terbaru: Maksimal tiga entri tempat Anda dapat mencantumkan peran penulisan teknis atau pengalaman kerja terbaru Anda. Jika Anda memiliki pengalaman dokumentasi open source, sertakan juga di sini. Rangkum peran Anda, tanggung jawab peran, dan pekerjaan yang Anda selesaikan. Anda dapat memberikan tanggal jika relevan.

  • Link ke resume atau CV Anda: (Opsional.) URL versi resume atau curriculum vitae (CV) Anda yang dapat diakses secara publik.

  • Link ke sampel karya Anda: (Opsional.) URL portofolio contoh tulisan yang dapat diakses secara publik, atau link individual ke contoh karya Anda.

  • Hal lain yang ingin Anda tambahkan: (Opsional.) Informasi apa pun yang Anda ingin tambahkan aplikasi ini. Misalnya, minat Anda dalam dokumentasi teknis, alasan Anda ingin berpartisipasi dalam Season Dokumen, atau pengalaman lain yang relevan.

Proposal proyek

Proposal project adalah ringkasan pekerjaan dokumentasi yang ingin Anda selesaikan saat bekerja dengan organisasi open source pilihan Anda selama Musim Dokumen.

Anda dapat mengirimkan maksimal tiga proposal proyek. Semua proposal project Anda harus dalam formulir permohonan yang sama.

Luangkan waktu untuk membuat proposal proyek Anda, dengan mengingat pedoman berikut.

Pekerjaan persiapan:

  • Periksa daftar organisasi open source yang berpartisipasi, lalu pilih satu atau beberapa organisasi yang Anda minati. Lihatlah ide-ide proyek yang telah diusulkan oleh setiap organisasi {i>open source<i} pilihan Anda.

    Organisasi open source yang berpartisipasi

  • Jika organisasi yang menarik minat Anda belum menyarankan ide apa pun, Anda dapat memeriksa daftar umum ide project dan mendasarkan ide Anda pada salah satu ide tersebut. Anda juga dapat memilih untuk menghasilkan ide sendiri, terlepas dari apakah organisasi telah memposting ide atau belum.

  • Hubungi satu atau beberapa organisasi yang berpartisipasi untuk mendiskusikan ide proyek. Untuk melakukan kontak, gunakan alamat email organisasi yang ditampilkan dalam daftar organisasi yang berpartisipasi. Diskusi awal membantu Anda menyusun proposal proyek yang baik.

Proposal proyek Anda pada formulir permohonan:

  • Nama organisasi open source: Masukkan nama organisasi open source yang ingin Anda ajak bekerja sama selama Season Dokumen. Organisasi ini harus merupakan salah satu organisasi yang berpartisipasi yang ditampilkan di situs Season of Dokumen.

    Organisasi open source yang berpartisipasi

  • Nama project open source: Ini adalah nama project open source yang ingin Anda kerjakan selama Season Dokumen. Project harus dimiliki oleh salah satu organisasi yang berpartisipasi yang ditampilkan di situs Season Dokumen. Untuk beberapa organisasi, nama organisasi dan nama project mungkin sama.

  • Nama proyek penulisan teknis yang Anda usulkan. Berikan judul singkat dan deskriptif yang merangkum tujuan utama dari pekerjaan yang Anda usulkan.

  • Deskripsi mendetail. Berikan detail sebanyak mungkin dalam deskripsi proyek penulisan teknis yang Anda usulkan. Anda dapat memasukkan beberapa paragraf di kolom deskripsi. Berikut beberapa ide yang harus disertakan:

    • Berikan detail dokumentasi yang Anda usulkan untuk dibuat/diperbarui. Jika Anda berencana untuk memperbarui dokumen atau situs yang sudah ada, sertakan link dan jelaskan update yang diusulkan. Jika Anda mengusulkan dokumen baru atau situs baru, deskripsikan konten dan audiensnya.
    • Katakan mengapa Anda mengusulkan dokumentasi baru atau pembaruan.
    • Jika Anda telah membahas project dengan seseorang dari organisasi open source, sertakan ringkasan hasil diskusi tersebut.
    • Perhatikan bahasa dan gaya proposal Anda. Organisasi open source dapat menggunakannya sebagai faktor dalam menilai proposal.
    • Jangan berikan link ke deskripsi project Anda. Deskripsi harus menyertakan semua detail definitif proyek Anda. Organisasi open source harus dapat membuat pilihan berdasarkan konten formulir permohonan, bukan konten yang disediakan di tempat lain. Tidak masalah jika Anda perlu menautkan ke konten lain yang melengkapi deskripsi, tetapi perlu diketahui bahwa hanya konten formulir permohonan yang digunakan untuk pemilihan project.

Kolom penting lainnya di formulir permohonan

Berikut adalah panduan tentang informasi penting lain yang harus Anda berikan dalam formulir permohonan:

  • Memilih project berdurasi standar atau berdurasi panjang: Periode standar untuk fase pengembangan dokumen Season Dokumen adalah tiga bulan. Jika project Anda memerlukan jangka waktu yang lebih lama, Anda harus menunjukkannya di formulir permohonan setelah berkonsultasi dengan organisasi open source pilihan Anda. Lihat deskripsi project yang berjalan lama.

  • Menerima gaji Musim Dokumen: Season Dokumen membayar sejumlah uang kepada penulis teknis yang berhasil menyelesaikan project mereka, asalkan penulis teknis ingin menerima gaji tersebut. Lihat informasi tentang tips teknis untuk penulis. Gaji bersifat opsional. Jika Anda tidak ingin menerima tunjangan, tentukan pilihan Anda pada formulir permohonan.

Cara Season Dokumen menggunakan informasi dari formulir permohonan Anda

Bagian ini merangkum cara Season Dokumen menggunakan informasi dari formulir permohonan Anda. Bagian sebelumnya di halaman ini menjelaskan kolom utama secara mendetail.

Tabel ini mencantumkan kolom utama. Untuk setiap kolom, tabel akan menunjukkan apakah Season Dokumen:

  • Meneruskan informasi ke organisasi open source yang telah Anda tentukan di formulir permohonan.
  • Memublikasikan informasi dalam daftar proyek penulisan teknis yang diterima di situs Season of Docs.
Informasi tentang formulir Dibagikan ke organisasi open source? Ditampilkan di Season situs Dokumen?
Nama lengkap
Nama tampilan
Alamat email
Pengalaman penulisan teknis terbaru
Link ke resume atau CV
Link ke sampel tugas
Hal lain yang ingin Anda tambahkan
Nama project/organisasi open source
Nama dan deskripsi proyek penulisan teknis
Project yang berjalan lama atau berdurasi standar
Penerimaan tunjangan

Kunci ke simbol yang digunakan dalam tabel di atas:

Simbol Arti simbol
Ya
Tidak

Catatan

Berikut beberapa poin lain yang perlu diperhatikan:

  • Mengirimkan beberapa proposal project: Anda dapat mengirimkan lebih dari satu proposal project, tetapi Season of Docs hanya menerima satu proposal project per penulis teknis. Anda hanya dapat mengirimkan satu formulir permohonan. Formulir ini memungkinkan hingga tiga proposal proyek.

  • Jumlah total project penulisan teknis dalam program: Musim Dokumen hanya dapat menerima jumlah total project penulisan teknis maksimum tertentu. Lihat cara kerja alokasi slot.

  • Lihat petunjuk untuk mentor tentang cara menilai proposal penulis teknis. Memahami kriteria pemilihan mentor membantu Anda membuat proposal yang lebih mungkin berhasil.

  • Untuk informasi prosedural tentang waktu dan cara mengirimkan pendaftaran Season Dokumen, lihat panduan penulis teknis.