Pertanyaan umum (FAQ)

Fase saat ini:
Program Season of Docs 2021 berakhir pada 14 Desember 2021. Lihat linimasa.

Umum

Apakah Season of Docs Google adalah program perekrutan?

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

Apa saja perubahan Google Season of Docs 2021?

Google Season of Docs 2021 memiliki perubahan signifikan dari tahun-tahun sebelumnya, termasuk:

  • Penulis teknis tidak lagi mendaftar melalui Google untuk dicocokkan dengan organisasi
  • Organisasi mengirimkan proposal project sebagai bagian dari permohonan mereka, 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 Google Season of Docs melakukan perubahan ini?

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

Organisasi kami ingin berpartisipasi dalam Season of Docs 2021, tetapi kami tidak tahu harus memulai dari mana.

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

Jenis project apa yang dapat diusulkan organisasi?

Berikut adalah beberapa ide:

  • Buat situs dokumentasi di platform yang akan diputuskan oleh penulis teknis dan organisasi open source, serta publikasikan kumpulan dokumen dasar awal di situs. Contoh platform mencakup:

  • Faktorkan ulang dokumentasi project open source yang ada untuk memberikan pengalaman pengguna yang lebih baik atau arsitektur informasi yang lebih mudah diakses.

  • Tulis ringkasan konseptual, atau pengantar, tentang 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 berprofil tinggi.

  • Buat serangkaian panduan cara yang terfokus untuk tugas tertentu.

  • Buat panduan kontributor yang menyertakan informasi dasar tentang cara memulai sebagai kontributor untuk project open source, serta aturan terkait perjanjian lisensi, proses untuk permintaan pull dan peninjauan, mem-build project, dan sebagainya.

Apakah video dapat menjadi project untuk Google Season of Docs?

Ya. Pastikan persyaratan video memiliki cakupan yang baik dan perhatikan bahwa produksi video berkualitas tinggi memerlukan waktu dan sumber daya yang signifikan.

Apakah audit dokumentasi merupakan project yang wajar untuk Google Season of Docs?

Audit dokumentasi adalah project yang bagus untuk Google Season of Docs. Perhatikan jumlah dokumentasi yang sudah Anda miliki; jika jumlahnya banyak, Anda mungkin perlu mengurangi cakupannya (misalnya, hanya mengaudit konten tutorial). Jika Anda memiliki sedikit atau tidak ada dokumentasi, sebaiknya sertakan pembuatan dokumentasi yang hilang dengan prioritas tertinggi sebagai bagian dari project Anda.

Apakah ada template dokumentasi yang dapat digunakan oleh organisasi dan penulis teknis?

Google Season of Docs memiliki repo GitHub dengan template dan checklist untuk melakukan audit dokumentasi. Kami berharap dapat menambahkan template lain saat dibuat.

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

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

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

Di mana Google Season of Docs berlangsung?

Google Season of Docs sepenuhnya dilakukan secara online. Tidak ada persyaratan untuk melakukan perjalanan sebagai bagian dari program ini.

Bagaimana cara agar saya tetap mendapatkan informasi tentang Google Season of Docs?

Buka milis pengumuman di season-of-docs-announce untuk mendapatkan info terbaru dan pengumuman terkait Google Season of Docs. Bergabunglah dengan grup untuk menerima info terbaru melalui email.

Dapatkah saya menambahkan linimasa Google Season of Docs ke kalender saya?

Ya, Anda dapat menambahkannya melalui link ini.

Apa yang dapat saya lakukan untuk membantu menyebarkan informasi tentang Google Season of Docs?

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

Bagaimana cara mengatur atau menyelenggarakan sesi informasi atau pertemuan Google Season of Docs?

Anda dapat menjadwalkan pertemuan kapan saja dan di mana saja sesuai keinginan Anda. Tinjau aturan program dan gunakan contoh konten.

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

Ya, hasil Google Season of Docs untuk program 2019 dapat dilihat di sini, dan hasil program 2020 dapat dilihat di sini.

Apakah saya akan mendapatkan kaus Google Season of Docs?

Tidak, karena kendala pengiriman internasional, kami tidak dapat lagi menyediakan T-shirt kepada peserta yang berhasil menyelesaikan project Google Season of Docs mereka.

Bagaimana jika saya memiliki pertanyaan lain?

Lihat panduan administrator organisasi dan panduan penulis teknis.

Jika setelah membaca semua dokumentasi, Anda masih tidak memiliki jawaban, pertimbangkan untuk mendiskusikan pertanyaan Anda dengan komunitas Google Season of Docs di daftar diskusi. Lihat informasi tentang saluran diskusi dan cara menghubungi kami.

Bagaimana cara menjadi mentor untuk Google Season of Docs?

Google Season of Docs 2021 tidak memiliki peran mentor formal. Organisasi harus menentukan cara penulis teknis akan diaktifkan dan didukung serta cara kontribusi dokumentasi mereka akan ditinjau dan disetujui sebagai bagian dari permohonan organisasi. Jika Anda tertarik untuk melatih penulis teknis sebagai bagian dari Google Season of Docs, sebaiknya Anda bekerja sama dengan administrator organisasi untuk menjadi sukarelawan.

Apakah Google Season of Docs seperti Google Summer of Code?

Tidak. Google Season of Docs ditujukan untuk orang-orang yang memiliki pengalaman menulis teknis, dan tidak dirancang sebagai program mentoring seperti Google Summer of Code.

Untuk penulis teknis

Kapan penulis teknis dapat mendaftar ke Google Season of Docs?

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

Alat dan framework dokumentasi apa yang harus saya ketahui untuk berpartisipasi dalam Google Season of Docs?

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

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

Cari tahu apakah organisasi yang Anda pilih sudah menghosting dokumentasi mereka di situs, dan jika ya, platform apa yang mereka gunakan. Platform tersebut dapat berupa pembuat situs statis seperti Jekyll, Sphinx, atau Hugo, atau organisasi dapat menghosting dokumennya di Read the Docs atau GitHub Pages. Setelah mengetahui platform yang digunakan organisasi, jelajahi dan bereksperimenlah dengan bahasa dan framework yang relevan. Hal ini membantu Anda memulai project open source dengan cepat, dan menempatkan Anda dalam posisi yang baik untuk memberikan saran yang baik kepada project open source pilihan Anda.

Bahasa pemrograman apa yang harus saya ketahui untuk berpartisipasi dalam project Google Season of Docs?

Bergantung pada sifat project dokumentasi Anda, Anda mungkin perlu memahami bahasa pemrograman. Perhatikan hal ini saat memilih dan menyarankan project dokumentasi, dan konsultasikan dengan organisasi open source tentang tingkat keakraban yang diperlukan.

Dapatkah penulis teknis yang sudah mengerjakan project open source terus mengerjakannya sebagai bagian dari Google Season of Docs?

Ya, tetapi organisasi harus mencantumkan 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 atau pelatihan menulis teknis sebelumnya lebih diutamakan, tetapi tidak wajib. Saat mengirimkan pernyataan minat ke organisasi, Anda dapat menjelaskan pengalaman dan/atau pelatihan Anda dalam penulisan teknis. Anda harus dapat 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 Google Season of Docs mereka.

Apakah saya akan dibayar untuk berpartisipasi dalam Google Season of Docs?

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

Seperti apa pernyataan minat penulis teknis yang baik?

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

Berapa lama waktu yang diperlukan untuk berpartisipasi dalam Google Season of Docs?

Ukuran project bervariasi, tetapi berkisar dari komitmen 5-30 jam per minggu selama program. Namun, jumlah waktu yang Anda habiskan bergantung pada sifat project yang telah Anda setujui dengan organisasi. Sebelum melakukan commit, Anda harus menilai project dan mendiskusikan estimasi waktu dengan organisasi open source.

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

Tidak, Anda hanya boleh mengirimkan proposal jika dapat menerima dana atas nama project open source. Sebaiknya hubungi project tersebut dan berkolaborasi dalam proposal aplikasi.

Saya seorang siswa, apakah saya memenuhi syarat untuk berpartisipasi dalam Google Season of Docs 2021? Apakah Google Season of Docs akan mengajarkan saya menjadi penulis teknis?

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

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

Meskipun saat ini tidak melanggar aturan, sebaiknya mahasiswa yang diterima di Google Summer of Code tidak mendaftar sebagai penulis teknis Google Season of Docs. Siswa harus berkonsentrasi pada tugas Google Summer of Code, bukan mendaftar ke Google Season of Docs.

Selain itu, Google Season of Docs tidak ditujukan untuk pemula, tetapi ditujukan untuk orang yang sudah memiliki keterampilan dan pengalaman menulis teknis yang solid hingga sangat baik. Penulis teknis di Season of Docs tidak dibimbing, dan sebagai gantinya harus mengelola diri sendiri dan termotivasi untuk mencari tahu rencana mereka dalam menangani project organisasi dengan panduan minimal dari admin organisasi dan anggota komunitas lainnya.

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

Anda dapat menghubungi administrator program Google Season of Docs dengan mengirim email ke season-of-docs@google.com.

Dapatkah perusahaan atau konsultan penulisan teknis berpartisipasi dalam Season of Docs?

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

Bagaimana cara mereferensikan Season of Docs di resume saya?

Cantumkan seperti yang Anda lakukan untuk pekerjaan lepas lainnya, misalnya "Bekerja sebagai penulis teknis untuk [nama project] sebagai bagian dari program Season of Docs".

Apakah Anda memberikan sertifikat kelulusan untuk berpartisipasi dalam Season of Docs?

Kami tidak dapat mengirimkan sertifikat atau konfirmasi partisipasi project 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 open source/gratis yang aktif, seperti BRL-CAD. Project tersebut tidak harus merupakan entitas yang didirikan secara hukum. Organisasi harus telah memproduksi dan merilis software berdasarkan lisensi yang disetujui Open Source Initiative dan memiliki minimal dua kontributor untuk berperan sebagai administrator organisasi selama seluruh program Google Season of Docs agar dapat berpartisipasi dalam program ini.

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

Apakah 'organisasi' setara dengan project open source?

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

Dapatkah organisasi mengirimkan lebih dari satu permohonan proposal?

Tidak. Harap hanya kirimkan satu permohonan per organisasi. Jika organisasi Anda memiliki sub-organisasi (misalnya, organisasi Anda adalah yayasan dengan banyak project open source individual), setiap project harus mengirimkan permohonannya sendiri, meskipun dana hibah akan ditangani oleh organisasi payung.

Dapatkah sekelompok project open source mengirimkan proposal bersama untuk mengerjakan satu project dokumentasi?

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

Bagaimana cara organisasi saya menerima dana?

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

Apakah organisasi menerima uang untuk berpartisipasi dalam Google Season of Docs?

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

Bagaimana cara organisasi saya menganggarkan biaya penulis teknis?

Sebaiknya lihat survei gaji Write the Docs dan hitung tarif per jam. Anda juga dapat bergabung ke Write The Docs Slack dan bertanya di channel #season-of-docs untuk mengajukan bid kepada penulis teknis yang berminat.

Dapatkah organisasi saya menggunakan hibah Google Season of Docs untuk membayar kontributor saat ini?

Ya. Namun, proposal project harus untuk pekerjaan baru (termasuk pekerjaan pemeliharaan, revisi, atau upgrade pada dokumentasi yang ada). Anda tidak boleh mengajukan permohonan hibah untuk digunakan membayar pekerjaan yang telah 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 sama dengan siswa, sebaiknya Anda membatasi partisipasi kepada siswa yang:

  • Berusia di atas 18 tahun
  • Terdaftar dalam program atau kursus penulisan teknis atau komunikasi teknis
  • Memiliki akses yang dapat ditunjukkan ke mentor penulisan teknis melalui program atau kursus 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 lebih banyak kerumitan pada project Anda dan memerlukan lebih banyak waktu sukarelawan dan administrasi.

Dapatkah organisasi saya menyewa perusahaan penulisan teknis untuk mengerjakan project kami?

Ya, organisasi Anda dapat menyewa perusahaan penulisan teknis untuk mengerjakan project Anda. Pastikan perusahaan yang Anda pekerjakan dapat dibayar melalui Open Collective.

Penulis teknis kami keluar sebelum akhir program. Apakah kami masih memenuhi syarat untuk menerima sisa dana?

Sebaiknya Anda mencoba menemukan penulis teknis baru untuk menyelesaikan project sebelum akhir program. Namun, pencairan dana yang tersisa tidak didasarkan pada penyelesaian project, tetapi pada penyelesaian studi kasus dan evaluasi akhir.

Jika project Anda tidak dapat diselesaikan, kami berharap studi kasus Anda akan memeriksa alasannya. Misalnya, Anda mungkin mendapati bahwa alat dokumentasi Anda sangat rumit dan terbukti menjadi penghalang untuk melakukan orientasi penulis teknis, atau bahwa project Anda melibatkan pengujian dan pembaruan tutorial serta memerlukan pengalaman coding yang luas. Apa yang akan Anda rekomendasikan kepada project lain, berdasarkan pengalaman Anda? Sertakan informasi tersebut dalam studi kasus Anda.

Dapatkah permohonan organisasi ditinjau sebelum batas waktu pengiriman?

Sayangnya, kami tidak dapat memberikan masukan terkait permohonan organisasi.

Bagaimana organisasi harus menentukan cakupan proposal project mereka?

Saat mengembangkan ide project, cobalah untuk menemukan project terkecil yang akan memberikan nilai bagi organisasi (tetapi dapat diperluas jika waktu memungkinkan). Makin kecil makin baik. Saat membuat proposal project, sebaiknya pilih project yang lebih kecil dan lebih mendetail daripada project yang lebih besar dan kurang spesifik. Jika project Anda memerlukan banyak keahlian domain, coba sertakan project yang dapat dikerjakan oleh seseorang tanpa latar belakang tersebut.

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

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

Organisasi kami berpartisipasi dalam program Google Season of Docs sebelumnya. Apakah kami memenuhi syarat untuk mendaftar lagi?

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

Data yang diarsipkan

Bagaimana cara menghapus informasi saya dari arsip Google Season of Docs?

Hubungi kami untuk menghapus informasi Anda.