Pertanyaan umum (FAQ)

Tahap saat ini:
Hasil diumumkan linimasa.

Umum

Apakah Season Dokumen merupakan program perekrutan?

Tidak. Jika Anda tertarik untuk bekerja di Google, kunjungi situs lowongan Google.

Apa perbedaan program saat ini dengan Season Dokumen 2019 dan 2020?

Musim program Dokumen saat ini memiliki perubahan signifikan dari tahun-tahun sebelumnya, termasuk:

  • Penulis teknis tidak lagi mendaftar melalui Google untuk dicocokkan dengan organisasi
  • Organisasi mengajukan proposal proyek sebagai bagian dari aplikasi, termasuk anggaran dan metrik yang diusulkan
  • Organisasi yang diterima akan menerima hibah, yang mereka gunakan untuk membayar penulis teknis
  • Organisasi mengirimkan evaluasi akhir dan studi kasus

Mengapa Season Dokumen membuat perubahan ini?

Di Google, misi kami adalah mengelola informasi dunia dan membuatnya dapat diakses serta berguna secara universal. Dengan memfokuskan kembali Musim Dokumen untuk menekankan pembelajaran tentang praktik dokumentasi yang efektif dalam open source, kami berharap dapat memberikan dampak yang lebih besar dalam jangka panjang.

Organisasi kami ingin berpartisipasi dalam Season Dokumen, tetapi kami tidak tahu harus mulai dari mana.

Lihat daftar lengkap ide project kami. Anda juga dapat menghubungi komunitas penulisan teknis (coba saluran #season-of-docs di Menulis Dokumen Slack atau di saluran media sosial untuk meminta bantuan atau proposal).

Jenis proyek apa yang dapat diusulkan oleh organisasi?

Berikut adalah beberapa ide:

  • Bangun situs dokumentasi di platform untuk ditentukan oleh penulis teknis dan organisasi open source, serta publikasikan kumpulan awal dokumen dasar di situs. 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.

Apakah video bisa menjadi project yang memungkinkan untuk Season Dokumen?

Ya. Pastikan persyaratan video tercakup dengan baik dan perlu diketahui bahwa produksi video berkualitas tinggi membutuhkan waktu dan sumber daya yang signifikan.

Apakah audit dokumentasi merupakan project yang wajar untuk Season Dokumen?

Audit dokumentasi adalah proyek yang sangat bagus untuk Season Dokumen. Perhatikan banyaknya dokumentasi yang sudah Anda miliki. Jika dokumentasi Anda banyak, Anda mungkin perlu mengurangi cakupannya (misalnya, hanya mengaudit konten tutorial). Jika hanya memiliki sedikit atau tidak memiliki dokumentasi, Anda dapat menyertakan membuat dokumentasi yang hilang dengan prioritas tertinggi sebagai bagian dari project Anda.

Apakah ada {i>template<i} dokumentasi yang tersedia untuk digunakan oleh organisasi dan penulis teknis?

Season Dokumen memiliki repo GitHub dengan template dan checklist untuk menjalankan audit dokumentasi. Kami berharap dapat menambahkan {i>template<i} lain saat mereka dibuat.

The Good Docs Project sedang berupaya membuat beberapa template dokumentasi minimum yang layak untuk open source.

Apakah organisasi diwajibkan untuk menggunakan dokumen yang dihasilkan oleh penulis teknis?

Tidak. Terkadang, project tidak berjalan seperti yang diharapkan, atau persyaratan berubah. Kami tidak mengharuskan organisasi untuk menggunakan dokumentasi atau materi lain yang dihasilkan, tetapi kami berharap bahwa evaluasi akhir dan studi kasus akan mencakup diskusi tentang alasan dokumentasi tidak digunakan, dan bagaimana project membuat keputusan untuk tidak menggunakan dokumentasi atau materi lain.

Di mana Season Dokumen tersedia?

Season Dokumen sepenuhnya tersedia secara online. Tidak ada persyaratan untuk bepergian sebagai bagian dari program ini.

Bagaimana cara mendapatkan informasi terbaru tentang Season Dokumen?

Kunjungi milis pengumuman di season-of-docs-announce untuk mengetahui info terbaru dan pengumuman terkait Season Dokumen. Bergabunglah dengan grup untuk menerima info terbaru melalui email.

Dapatkah saya menambahkan linimasa Season Dokumen ke kalender?

Ya, Anda dapat menambahkannya melalui link ini.

Apa yang dapat saya lakukan untuk membantu menyebarkan informasi tentang Season Dokumen?

Anda dapat mengirim tweet tentang program, menulis postingan blog, memublikasikan video, atau menyelenggarakan pertemuan atau sesi informasi di area Anda. Kami memiliki beberapa contoh konten dan referensi yang dapat Anda gunakan untuk didistribusikan ke komunitas (organisasi, grup penulis, dan kontak lainnya).

Bagaimana cara menyelenggarakan atau menyelenggarakan pertemuan atau sesi informasi Season Dokumen?

Anda dapat menjadwalkan pertemuan kapan pun dan di tempat yang tepat bagi Anda. Tinjau aturan program dan gunakan contoh konten.

Apakah ada statistik yang dapat Anda bagikan terkait Dokumen Musim 2019 dan 2020?

Ya, hasil Season Dokumen kami untuk program 2019 dapat dilihat di sini, dan hasil program 2020 kami dapat dilihat di sini.

Apakah saya akan mendapatkan Kaus Musim Dokumen?

Tidak, karena kendala pengiriman internasional, kami tidak lagi dapat menyediakan kaos kepada peserta yang berhasil menyelesaikan project Musim Dokumen mereka.

Bagaimana jika saya memiliki pertanyaan lain?

Lihat panduan administrator organisasi dan panduan penulis teknis.

Jika setelah membaca semua dokumentasi Anda masih belum memiliki jawaban, sebaiknya diskusikan pertanyaan Anda dengan komunitas Season of Docs dalam daftar diskusi. Lihat informasi tentang saluran diskusi dan cara menghubungi kami.

Bagaimana cara menjadi mentor untuk Season Dokumen?

Season Dokumen tidak memiliki peran mentor formal. Organisasi harus menentukan cara penulis teknis diaktivasi dan didukung, serta bagaimana kontribusi dokumentasi mereka akan ditinjau dan disetujui sebagai bagian dari permohonan organisasi. Jika Anda tertarik untuk membimbing penulis teknis sebagai bagian dari Season Dokumen, sebaiknya bekerja sama dengan administrator organisasi Anda untuk menjadi sukarelawan.

Apakah Season Dokumen seperti Google Summer of Code?

Tidak. Season Dokumen ditujukan untuk orang yang memiliki pengalaman menulis teknis. Season Dokumen ini tidak dirancang sebagai program bimbingan seperti Google Summer of Code.

Untuk penulis teknis

Kapan penulis teknis dapat mendaftar untuk Season Dokumen?

Season Dokumen tidak memiliki aplikasi penulis teknis formal. Untuk berpartisipasi dalam Season Dokumen sebagai penulis teknis, hubungi organisasi open source secara langsung, menggunakan petunjuk di halaman program Season Dokumen mereka. Anda juga dapat menyatakan minat Anda dengan menambahkan diri Anda ke Musim Direktori Penulis Teknis Dokumen. Lihat panduan penulis teknis untuk informasi selengkapnya.

Alat dan framework dokumentasi apa yang harus saya ketahui untuk berpartisipasi dalam Season Dokumen?

Framework dan alat dokumentasi yang akan Anda gunakan bergantung pada organisasi yang ingin Anda ajak bekerja sama. Bagian dari tujuan Musim Dokumen adalah untuk proyek open source guna membantu penulis teknis mempelajari lebih lanjut alat dan framework yang terlibat dalam mendokumentasikan produk open source. Oleh karena itu, biasanya Anda tidak harus memiliki pengetahuan mendetail tentang platform dokumentasi tertentu sebelum memulai project Season Dokumen.

Dengan demikian, sebagian besar organisasi open source menggunakan beberapa ragam Markdown atau bahasa markup lainnya untuk dokumentasi mereka. Sebaiknya cari tahu bahasa mana yang digunakan organisasi yang Anda pilih dan pahami sintaksisnya. Markdown adalah awal yang baik, karena file README GitHub menggunakan sedikit dari Markdown. Lihat panduan GitHub untuk Markup.

Cari tahu apakah organisasi pilihan Anda sudah menghosting dokumentasinya di situs, dan jika ya, platform apa yang mereka gunakan. Platform tersebut dapat berupa generator situs statis seperti Jekyll, Sphinx, atau Hugo, atau organisasi dapat menghosting dokumen mereka di Read the Docs atau GitHub Pages. Setelah Anda mengetahui platform apa yang digunakan organisasi, pelajari dan bereksperimen dengan bahasa dan framework yang relevan. Dengan begitu, Anda dapat memulai project open source dengan cepat, dan dapat memberikan saran yang bagus untuk project open source pilihan Anda.

Bahasa pemrograman apa yang harus saya ketahui untuk berpartisipasi dalam Season project Dokumen?

Bergantung pada sifat project dokumentasi, Anda mungkin perlu menguasai bahasa pemrograman. Ingatlah hal ini saat memilih dan mengusulkan project dokumentasi, dan konsultasikan tingkat pemahaman yang diperlukan dengan organisasi open source.

Dapatkah penulis teknis yang sudah mengerjakan proyek open source terus mengerjakannya sebagai bagian dari Season Dokumen?

Ya, tetapi organisasi harus mencatat hubungan penulis teknis sebelumnya atau yang sedang berlangsung dengan project dalam proposal mereka.

Apa saja persyaratan kelayakan untuk berpartisipasi?

Apakah saya memerlukan pengalaman atau pelatihan sebelumnya sebagai penulis teknis?

Pengalaman penulisan teknis atau pelatihan sebelumnya lebih baik, tetapi tidak terlalu penting. Saat mengirimkan pernyataan minat kepada organisasi, Anda dapat menjelaskan pengalaman dan/atau pelatihan Anda dalam penulisan teknis. Anda harus bisa memberikan beberapa bukti yang menunjukkan minat Anda pada dokumentasi teknis atau dokumentasi open source, termasuk contoh dokumentasi yang telah Anda tulis. Organisasi open source akan mencari penulis teknis dengan tingkat pengalaman yang dibutuhkan organisasi, untuk memastikan keberhasilan penyelesaian project Season of Dokumen.

Apakah saya akan dibayar karena berpartisipasi dalam Season Dokumen?

Ya. Google akan memberikan hibah kepada organisasi yang diterima untuk mempekerjakan penulis teknis.

Seperti apa pernyataan minat penulis teknis yang baik?

Pernyataan minat terbaik adalah dari penulis teknis yang meluangkan waktu untuk berinteraksi dan mendiskusikan ide-ide mereka dengan organisasi open source pilihan mereka sebelum mengirimkan pernyataan. Lihat panduan untuk membuat pernyataan minat Anda.

Berapa lama waktu yang diperlukan selama partisipasi dalam Musim Dokumen?

Ukuran project bervariasi, tetapi bervariasi dari komitmen 5-30 jam per minggu selama program berlangsung. Namun, jumlah waktu yang Anda habiskan bergantung pada sifat project yang telah Anda sepakati dengan organisasi. Sebelum berkomitmen, Anda harus menilai project dan mendiskusikan perkiraan waktu dengan organisasi open source.

Dapatkah saya mengirimkan permohonan organisasi untuk membuat dokumentasi bagi project open source sebagai perorangan? Saya ingin membuat serangkaian postingan blog, video, atau materi lain tentang cara menggunakan alat atau proyek open source, tetapi saya bukan bagian dari atau kontributor proyek tersebut.

Tidak, Anda hanya boleh mengirim proposal jika Anda dapat menerima dana atas nama project open source. Kami mendorong Anda untuk menghubungi project dan berkolaborasi terkait proposal pendaftaran.

Saya seorang siswa, apakah saya memenuhi syarat untuk berpartisipasi dalam Season Dokumen? Apakah Season Dokumen akan mengajari saya menjadi penulis teknis?

Siswa memenuhi syarat untuk bekerja dengan organisasi yang diterima, tetapi Season of Docs tidak dimaksudkan untuk mengajarkan keterampilan menulis teknis. Kami berharap penulis teknis yang berpartisipasi akan memiliki keterampilan menulis teknis profesional atau pengalaman relevan yang setara. Siswa yang ingin berpartisipasi harus memastikan untuk menyoroti pengalaman menulis dan mengedit yang relevan saat menghubungi organisasi dan proyek yang berminat.

Dapatkah saya berpartisipasi sebagai penulis teknis di Season of Docs dan juga siswa di Google Summer of Code?

Meskipun saat ini tidak melanggar aturan, kami sangat menyarankan agar siswa yang diterima di Google Summer of Code tidak bisa menjadi penulis teknis Musim Dokumen. Siswa harus berkonsentrasi pada tugas Google Summer of Code alih-alih mendaftar ke Season Dokumen.

Selain itu, Season Dokumen tidak ditujukan untuk pemula, tetapi ditujukan bagi orang-orang yang sudah memiliki keterampilan dan pengalaman menulis teknis yang kuat hingga hebat. Penulis teknis di Season of Docs tidak dibimbing, dan sebagai gantinya harus terorganisir dan termotivasi untuk menyusun rencana dalam menangani project organisasi dengan sedikit panduan dari admin org dan anggota komunitas lainnya.

Sebagai penulis teknis, bagaimana cara menghubungi administrator program Google Season of Docs jika ada pertanyaan atau masalah lain?

Anda dapat menghubungi administrator program Google Season untuk Dokumen dengan mengirimkan email kepada mereka di season-of-docs@google.com.

Apakah konsultan atau perusahaan penulisan teknis dapat berpartisipasi dalam Season Dokumen?

Ya, organisasi dapat menyewa perusahaan untuk melakukan pekerjaan yang diuraikan dalam proposal mereka.

Bagaimana cara mencantumkan Season Dokumen di resume saya?

Cantumkan seperti pekerjaan lepas lainnya, mis. "Bekerja sebagai penulis teknis untuk [nama proyek] sebagai bagian dari program Musim Dokumen".

Apakah Anda memberikan sertifikat kelulusan untuk berpartisipasi dalam Season Dokumen?

Kami tidak dapat mengirimkan sertifikat atau konfirmasi partisipasi proyek kepada penulis teknis.

Untuk administrator organisasi open source

Apa saja persyaratan kelayakan untuk organisasi open source?

Agar memenuhi syarat untuk berpartisipasi sebagai organisasi, Anda harus merupakan grup yang menjalankan project software gratis/open source aktif, seperti BRL-CAD. Project ini tidak harus merupakan entitas yang berbadan hukum. Organisasi harus sudah membuat dan merilis software berdasarkan lisensi yang disetujui Inisiatif Open Source dan memiliki minimal dua kontributor untuk berperan sebagai administrator organisasi untuk seluruh program Season Dokumen agar dapat berpartisipasi dalam program ini.

Lihat juga persyaratan kelayakan yang dijelaskan dalam aturan program dan Program Sanksi dan Informasi Negara dari Departemen Keuangan AS.

Apakah 'organisasi' setara dengan project open source?

Organisasi mungkin memiliki satu atau beberapa project open source. Beberapa organisasi, seperti yayasan, mungkin memiliki beberapa suborganisasi yang masing-masing memiliki satu atau beberapa project open source. Jika organisasi Anda memiliki suborganisasi independen, kirimkan permohonan dan proposal terpisah untuk setiap suborganisasi.

Dapatkah organisasi mengirimkan lebih dari satu permohonan proposal?

Tidak. Harap hanya kirimkan satu permohonan per organisasi. Jika organisasi Anda memiliki suborganisasi (misalnya, organisasi Anda adalah yayasan yang memiliki banyak project open source individual), setiap project harus mengirimkan permohonan mereka sendiri, meskipun dana hibah akan ditangani oleh organisasi induk.

Dapatkah sekelompok proyek {i>open source<i} mengajukan proposal bersama untuk mengerjakan satu proyek dokumentasi?

Satu organisasi harus mengirimkan permohonan proposal dan bertanggung jawab untuk mengkoordinasikan pekerjaan dan dukungan dari project lain yang berpartisipasi. (Misalnya, sekelompok project open source kecil yang semuanya merupakan plugin untuk project lebih besar yang ingin mengerjakan panduan cara kerja bersama untuk membuat plugin harus memilih satu organisasi untuk memimpin project.)

Bagaimana organisasi saya akan menerima dana?

Untuk menerima dana, organisasi Anda harus memiliki akun Open Collective.

Apakah organisasi menerima uang dengan berpartisipasi dalam Season Dokumen?

Organisasi dapat menyertakan dana untuk administrasi, bimbingan, atau meninjau pekerjaan sebagai bagian dari anggaran project mereka.

Apakah Google menanggung biaya pemrosesan pembayaran?

Biaya pemrosesan pembayaran tidak ditanggung oleh Google karena biaya ini cenderung berbeda bergantung pada metode pembayaran. Namun, Google menanggung biaya platform Open Collective, dan jika Anda memutuskan untuk menggunakan Open Collective sebagai host fiskal Anda, biaya tersebut juga tercakup. Lihat panduan Menerima Hibah untuk info selengkapnya.

Bagaimana cara organisasi saya menganggarkan biaya penulis teknis?

Sebaiknya lihat Survei gaji Dokumen dan cari tahu tarif per jamnya. Anda juga dapat bergabung dengan Write The Docs Slack dan meminta penawaran dari penulis teknis yang tertarik di channel #season-of-docs.

Apakah organisasi saya dapat menggunakan hibah Season Dokumen untuk membayar kontributor saat ini?

Ya. Namun, proposal project harus ditujukan untuk pekerjaan baru (termasuk pekerjaan pemeliharaan, revisi, atau upgrade untuk dokumentasi yang ada). Anda tidak boleh mengajukan permohonan hibah yang digunakan untuk membayar pekerjaan yang sudah selesai.

Dapatkah organisasi saya bekerja sama dengan penulis teknis siswa?

Anda dapat memilih untuk meminta penulis teknis siswa mengerjakan project Anda. Jika Anda memilih untuk bekerja dengan siswa, sebaiknya batasi partisipasi untuk siswa yang:

  • Berusia di atas 18 tahun
  • Terdaftar dalam program atau materi penulisan teknis atau komunikasi teknis
  • Memiliki akses yang terbukti ke bimbingan penulisan teknis melalui program atau materi mereka

Dapatkah organisasi saya bekerja sama dengan lebih dari satu penulis teknis?

Organisasi Anda dapat memilih dan membayar lebih dari satu penulis teknis, tetapi semua penulis teknis yang bekerja dengan organisasi Anda harus mengerjakan project yang Anda usulkan. Bekerja dengan beberapa penulis teknis akan menambah kerumitan pada project Anda dan membutuhkan lebih banyak waktu sukarela serta administrasi.

Bisakah organisasi saya menyewa perusahaan penulisan teknis untuk mengerjakan proyek kami?

Ya, organisasi Anda mungkin menyewa perusahaan penulisan teknis untuk mengerjakan proyek Anda. Pastikan perusahaan yang Anda pekerjakan dapat menerima pembayaran melalui Open Collective.

Penulis teknis kami berhenti belajar sebelum program berakhir. Apakah kami masih memenuhi syarat untuk menerima dana yang tersisa?

Kami sangat menyarankan Anda untuk mencari penulis teknis baru guna menyelesaikan project sebelum akhir program ini. Namun, pencairan dana yang tersisa tidak didasarkan pada penyelesaian proyek, tetapi pada penyelesaian studi kasus dan evaluasi akhir.

Jika proyek Anda tidak dapat diselesaikan, kami berharap studi kasus Anda memeriksa alasannya. Misalnya, Anda mungkin menemukan bahwa alat dokumentasi Anda sangat rumit dan terbukti menghambat orientasi penulis teknis, atau bahwa project Anda melibatkan pengujian dan pembaruan tutorial serta membutuhkan pengalaman coding yang ekstensif. Apa yang akan Anda rekomendasikan kepada proyek lain, berdasarkan pengalaman Anda? Sertakan informasi itu dalam studi kasus Anda.

Dapatkah permohonan organisasi ditinjau sebelum batas waktu pengiriman?

Sayangnya, kami tidak dapat memberikan masukan terkait pengajuan permohonan untuk organisasi ini.

Bagaimana seharusnya organisasi mencakup proposal proyek mereka?

Saat mengembangkan ide project, cobalah untuk menemukan project terkecil yang akan memberikan nilai bagi organisasi (tetapi dapat diperluas jika waktu memungkinkan). Lebih kecil lebih baik. Saat membuat proposal project, sebaiknya Anda tetap memilih project yang lebih kecil dan lebih mendetail daripada project besar yang tidak terlalu ditentukan. Jika project Anda membutuhkan banyak keahlian domain, coba sertakan project yang dapat dikerjakan oleh seseorang yang tidak memiliki latar belakang tersebut.

Dapatkah saya berpartisipasi sebagai administrator organisasi di Season Dokumen dan sebagai mentor dalam Google Summer of Code?

Ya. Season Dokumen dan Google Summer of Code adalah program terpisah. Tidak masalah jika Anda memiliki bandwidth untuk berpartisipasi dalam kedua program tersebut.

Organisasi kami berpartisipasi dalam Season program Dokumen sebelumnya. Apakah kami memenuhi syarat untuk mendaftar lagi?

Ya, organisasi yang telah berpartisipasi dalam program Season of Dokumen sebelumnya memenuhi syarat untuk mendaftar lagi.

Data yang diarsipkan

Bagaimana cara menghapus informasi saya dari arsip Season Dokumen?

Hubungi kami agar informasi Anda dihapus.