Pertanyaan umum (FAQ)

Fase saat ini:
Pengembangan dokumentasi. Lihat linimasa.

Umum

Apakah Google Season of Docs merupakan program perekrutan?

Tidak. Jika Anda tertarik bekerja untuk Google, kunjungi situs Google Lowongan.

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

Lihat daftar lengkap ide project kami. Anda juga dapat menghubungi komunitas penulisan teknis (coba

season-of-docs di dalam

Tulis Dokumen Slack atau di saluran media sosial Anda untuk meminta bantuan atau proposal).

Jenis proyek apa yang dapat diusulkan oleh organisasi?

Berikut adalah beberapa ide:

  • Buat situs dokumentasi di platform untuk ditentukan oleh penulis teknis dan organisasi open source, serta publikasikan kumpulan awal dokumen dasar di situs tersebut. 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 mencakup informasi dasar tentang cara memulai sebagai kontributor project open source, serta aturan apa pun seputar perjanjian lisensi, proses untuk permintaan pull dan peninjauan, pembuatan project, dan sebagainya.

Apakah video merupakan proyek yang mungkin untuk Google Season Dokumen?

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

Apakah audit dokumentasi merupakan proyek yang wajar untuk Google Season Dokumen?

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

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

Google Season Dokumen memiliki repo GitHub dengan template dan checklist untuk menjalankan audit dokumentasi. Template lain akan ditambahkan saat dibuat.

The Good Docs Project berupaya membuat beberapa template dokumentasi minimum yang valid 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 materi lain yang dibuat, tetapi kami berharap bahwa evaluasi akhir dan studi kasus akan mencakup pembahasan tentang alasan dokumentasi tidak digunakan, dan bagaimana project membuat keputusan untuk tidak menggunakan dokumentasi atau materi lainnya.

Di mana Google Season Dokumen diadakan?

Google Season Dokumen muncul sepenuhnya secara online. Tidak ada persyaratan untuk melakukan perjalanan sebagai bagian dari program ini.

Bagaimana cara untuk terus mendapatkan informasi tentang Google Season Dokumen?

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

Dapatkah saya menambahkan linimasa Google Season Dokumen ke kalender?

Gunakan http://goo.gle/2NeZVew untuk berlangganan kalender Google Season Dokumen.

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

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

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

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

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

Ya, hasil Google Season Dokumen kami untuk program 2019 dapat dilihat di Blog Open Source Google (2019, 2020).

Apakah saya akan mendapatkan kaos Google Season Dokumen?

Tidak, karena keterbatasan pengiriman internasional, Google Season Dokumen tidak lagi dapat menyediakan kaus kepada peserta yang berhasil menyelesaikan project Google Season Dokumen.

Bagaimana jika saya memiliki pertanyaan lain?

Lihat panduan administrator organisasi dan panduan penulis teknis.

Jika setelah membaca semua dokumentasi Anda masih belum 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 Dokumen?

Google Season of Docs tidak memiliki peran mentor formal. Organisasi harus menentukan cara penulis teknis akan diaktivasi dan didukung serta bagaimana kontribusi dokumentasi mereka akan ditinjau dan disetujui sebagai bagian dari pendaftaran organisasi. Jika Anda tertarik untuk membimbing penulis teknis sebagai bagian dari Google Season of Dokumen, hubungi administrator organisasi Anda untuk menjadi sukarelawan.

Apakah Google Season Dokumen seperti Google Summer of Code?

Tidak. Google Season of Docs ditujukan bagi orang-orang yang memiliki pengalaman menulis teknis. Google Season of Docs tidak dirancang sebagai program bimbingan seperti Google Summer of Code.

Untuk penulis teknis

Kapan penulis teknis dapat mendaftar untuk Google Season Dokumen?

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

Kerangka kerja dan alat dokumentasi apa yang harus saya ketahui untuk berpartisipasi dalam Google Season of Docs?

Alat dan framework dokumentasi yang akan digunakan bergantung pada organisasi yang ingin Anda ajak bekerja sama. Sebagian tujuan Google Season of Docs 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, biasanya Anda tidak harus memiliki pengetahuan mendetail tentang platform dokumentasi tertentu sebelum memulai project Google Season of Dokumen.

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

Cari tahu apakah organisasi yang Anda pilih sudah menghosting dokumentasinya di suatu situs, dan jika sudah, platform apa yang mereka gunakan. Platform ini dapat berupa generator situs statis seperti Jekyll, Sphinx, atau Hugo, atau organisasi dapat menghosting dokumennya di Read the Docs atau GitHub Pages. Setelah Anda mengetahui platform yang digunakan organisasi, pelajari dan bereksperimenlah dengan bahasa dan framework yang relevan. Hal ini membantu Anda memulai project open source dengan cepat, dan memberi Anda saran yang tepat untuk project open source pilihan Anda.

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

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

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

Bisa, tetapi organisasi harus mencatat hubungan penulis teknis sebelumnya atau berkelanjutan dengan project dalam proposalnya.

Apa saja persyaratan kelayakan untuk berpartisipasi?

Apakah saya memerlukan pengalaman atau pelatihan sebelumnya sebagai penulis teknis?

Pengalaman atau pelatihan menulis teknis sebelumnya lebih disukai, tetapi tidak penting. Saat mengirimkan pernyataan minat kepada organisasi, Anda dapat menjelaskan pengalaman atau pelatihan apa pun yang Anda dapatkan secara tertulis. 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 jika berpartisipasi dalam Season Google Dokumen?

Ya. Google akan memberikan hibah kepada organisasi yang diterima untuk digunakan 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 mereka dengan organisasi open source yang mereka pilih sebelum mengirimkan pernyataan mereka. Lihat panduan untuk membuat pernyataan minat Anda.

Berapa lama waktu yang diperlukan untuk partisipasi Google Season Dokumen?

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

Bisakah saya mengirim permohonan organisasi untuk membuat dokumentasi 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 mengirimkan proposal jika dapat menerima dana atas nama project open source. Jika Anda tertarik untuk berpartisipasi sebagai bagian dari project, hubungi project dan berkolaborasilah dalam membuat proposal aplikasi.

Saya seorang pelajar, apakah saya memenuhi syarat untuk berpartisipasi dalam Google Season Dokumen? Apakah Google Season of Docs akan mengajari saya untuk menjadi penulis teknis?

Siswa memenuhi syarat untuk bekerja sama dengan organisasi yang diterima, tetapi Google Season Dokumen tidak dimaksudkan untuk mengajarkan keterampilan menulis teknis. Penulis teknis yang berpartisipasi diharapkan memiliki keterampilan menulis teknis profesional atau pengalaman relevan yang setara. Siswa yang ingin berpartisipasi harus yakin untuk menyoroti pengalaman menulis dan mengedit yang relevan saat mendaftar.

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

Kontributor atau siswa baru yang diterima di Google Summer of Code tidak disarankan untuk mendaftar menjadi penulis teknis Google Season of Dokumen.

Google Season Dokumen tidak ditujukan untuk pemula, melainkan bagi orang yang sudah memiliki keterampilan dan pengalaman menulis teknis yang solid dan hebat. Penulis teknis di Google Season of Docs tidak dibimbing, dan harus terorganisir serta termotivasi untuk mengetahui rencana mereka dalam menangani project organisasi dengan sedikit panduan dari admin org dan anggota komunitas lainnya.

Sebagai penulis teknis, bagaimana cara menghubungi administrator program Google Dokumen untuk Musim Google Dokumen jika saya memiliki masalah atau pertanyaan tambahan?

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

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

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

Bagaimana cara merujuk Google Season Dokumen di resume saya?

Cantumkan seperti yang Anda lakukan pada pekerjaan {i>freelance<i} lainnya: "Bekerja sebagai penulis teknis untuk [nama proyek] sebagai bagian dari program Google Season of Docs".

Apakah Anda memberikan sertifikat kelulusan karena telah berpartisipasi dalam Google Season Dokumen?

Google Season of Docs 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 gratis atau open source aktif, seperti BRL-CAD. Project tersebut tidak harus merupakan entitas yang didirikan secara hukum. Organisasi harus sudah membuat dan merilis software berdasarkan lisensi yang disetujui Inisiatif Open Source dan memiliki setidaknya dua kontributor untuk berperan sebagai administrator organisasi untuk seluruh program Google Dokumen agar dapat berpartisipasi dalam program ini.

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

Apakah 'organisasi' setara dengan project open source?

Sebuah 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. 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 permohonannya sendiri, meskipun dana hibah akan ditangani oleh organisasi induk.

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

Satu organisasi harus mengajukan 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 Google 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 cenderung berbeda bergantung pada metode pembayarannya. Namun, Google akan 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 organisasi saya dapat menganggarkan biaya penulis teknis?

Sebaiknya baca artikel Menulis survei gaji Dokumen dan menghitung tarif per jam. Anda juga dapat bergabung dalam Write The Docs Slack dan meminta penawaran dari penulis teknis di channel #season-of-docs.

Dapatkah organisasi saya menggunakan hibah Google 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 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 dan komunikasi teknis
  • Memiliki akses yang dapat dibuktikan ke bimbingan menulis 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 sama dengan organisasi Anda harus mengerjakan project yang Anda ajukan. Bekerja dengan beberapa penulis teknis akan menambah kerumitan pada project Anda serta memerlukan lebih banyak waktu sukarela dan administrasi.

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

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

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

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

Jika proyek Anda tidak dapat diselesaikan, studi kasus harus mengetahui alasannya. Misalnya, Anda mungkin mendapati bahwa alat dokumentasi Anda sangat rumit dan terbukti menjadi hambatan dalam orientasi penulis teknis, atau bahwa project Anda melibatkan pengujian dan pembaruan tutorial serta memerlukan pengalaman coding yang ekstensif. Apa yang akan Anda rekomendasikan untuk proyek lain, berdasarkan pengalaman Anda? Masukkan informasi itu dalam studi kasus Anda.

Dapatkah permohonan organisasi ditinjau sebelum batas waktu pengiriman?

Sayangnya, Google Season of Dokumen tidak dapat memberikan masukan tentang permohonan organisasi.

Bagaimana seharusnya organisasi menentukan ruang lingkup 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 tetap gunakan project yang lebih kecil dan lebih mendetail, bukan project besar yang tidak terlalu spesifik. Jika project Anda memerlukan banyak keahlian domain, coba sertakan project yang dapat dikerjakan oleh seseorang yang tidak memiliki latar belakang tersebut.

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

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

Organisasi kami berpartisipasi dalam program Dokumen Musim Google sebelumnya. Dapatkah organisasi kami mendaftar lagi?

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

Data yang diarsipkan

Bagaimana cara menghapus informasi saya dari arsip Google Season Dokumen?

Hubungi kami agar informasi Anda dihapus.