Ditulis oleh James Scott, Technical writer
Penulisan teknis itu sederhana - Anda hanya perlu menjelaskan teknologi yang sangat rumit kepada audience yang tak kenal ampun. Tidak mengherankan kalau begitu banyak engineer beranggapan bahwa menulis dokumentasi adalah bagian paling menyakitkan dari tugas mereka. Jika Anda ingin mengajari kolega untuk menjadi penulis, kabar baiknya adalah materi kursus penulisan teknis yang menyenangkan dan interaktif dari Google tersedia secara gratis dan boleh digunakan semua orang! Atau, jika Anda seorang developer yang ingin belajar menulis dengan lebih jelas, Anda bisa membaca sendiri kursusnya atau meyakinkan seorang kolega untuk mengajar kursus di organisasi Anda!
Kami meneliti dokumentasi secara ekstensif, dan ternyata kalimat terbaik di dunia terdiri dari kata-kata. Kursus kami yang serba mandiri dan dipimpin oleh fasilitator tidak hanya akan membantu software engineer memilih kata-kata yang tepat, tetapi juga membantu membuat keseluruhan proses penulisan menjadi tidak begitu menakutkan. Mungkin software engineer tidak akan menjadi William Shakespeare atau bahkan William Shatner dalam semalam, tetapi mudah-mudahan mereka akan mendapatkan kepercayaan diri untuk menulis sesuatu yang layak dipublikasikan. Karena bekerja dari rumah menjadi semakin umum, dokumentasi yang baik akan semakin penting sehingga software engineer bisa bekerja secara mandiri.
Ringkasan kursus
Google memperkenalkan kursus penulisan teknis, Penulisan Teknis Satu dan Penulisan Teknis Dua, pada tahun 2015. Sejak itu, ribuan software engineer dan manajer produk Google telah mengikuti dan menikmati kursus tersebut. Pada bulan Februari 2020, kami merilis kursus ini ke dunia.
Kelas kursus memiliki struktur berikut:
- Siswa menyelesaikan tugas belajar mandiri sebelum menghadiri kelas langsung. Tugas belajar mandiri sangatlah berharga, bahkan bagi siswa yang tidak pernah menghadiri kelas langsung.
- Seorang fasilitator membimbing siswa melalui kelas langsung. Kelas langsung ini menampilkan latihan praktik, diskusi kelas, dan masukan sesama rekan yang ekstensif. Perhatikan bahwa Google tidak memimpin kursus langsung ini tetapi menyediakan materi yang ekstensif untuk membantu fasilitator mempersiapkan diri dalam memimpinnya.
Organisasi bisa memilih untuk menjadi host kelas langsung secara virtual atau tatap muka.
Penulisan Teknis Satu
Kursus pertama, Penulisan Teknis Satu, mencakup dasar-dasar penulisan teknis. Siswa belajar untuk mulai berpikir tentang audience mereka bahkan sebelum meletakkan pena di atas kertas. Sebagai contoh, dalam satu latihan, siswa ditantang untuk menulis petunjuk meletakkan pasta gigi pada sikat gigi. Ini mungkin terdengar sederhana, tetapi masalahnya - audience Anda belum pernah menyikat gigi mereka sebelumnya. Ini tidak berarti kebersihan mulut mereka buruk, tetapi mereka tidak tahu apa itu sikat gigi. Latihan ini bertujuan untuk membuat siswa berpikir tentang mendokumentasikan teknologi yang sama sekali baru.
Pelajaran penting lainnya yang diajarkan dalam Penulisan Teknis Satu adalah bagaimana cara mempersingkat panjang kalimat dalam dokumentasi Anda dan bagaimana cara mengedit kalimat yang terlalu panjang. Semoga setelah mengikuti kursus ini, Anda bisa mengedit kalimat sebelumnya menjadi seperti berikut: Pelajaran penting lainnya adalah Penulisan Teknis Satu mengajari Anda untuk mempersingkat kalimat dalam dokumentasi Anda dan cara mengedit kalimat yang terlalu panjang.
Kursus ini juga menganjurkan penggunaan daftar sebagai pengganti dinding teks, jadi di sini, dalam bentuk daftar, adalah beberapa topik lain yang dibahas:
- Menggunakan kalimat aktif sebagai pengganti kalimat pasif.
- Merevisi teks menjadi paragraf yang jelas.
- Mempelajari berbagai teknik pengeditan mandiri.
Penulisan Teknis Dua
Penulisan Teknis Dua dibangun berdasarkan teknik dari kursus pertama dan ditujukan bagi mereka yang sudah memahami kata kerja dari kata keterangan. Kursus ini mendorong siswa untuk mengekspresikan sisi kreatifnya. Sebagai contoh, dalam satu latihan, siswa menemukan cara terbaik untuk menggambarkan konsep-konsep teknis. Pemberitahuan spoiler: bisakah Anda menemukan masalah dengan diagram berikut ini?
Gambar 1: Menemukan situs web melalui DNS
Teknik menengah lainnya yang dibahas oleh kursus ini adalah:
- Mengatur set dokumen besar.
- Merevisi dan mengatur ulang teks.
- Menulis deskripsi yang akurat.
- Membuat tutorial untuk pemula.
Siswa mengambil bagian dalam latihan interaktif dan ulasan dengan sesama mitra lab. Penulisan Teknis Dua juga mencakup diskusi kelas tentang jenis-jenis dokumentasi dan cara mengalahkan rasa takut saat menulis draf pertama.
Ingin tahu lebih banyak?
Jika Anda ingin mengajar kursus di organisasi Anda sendiri, lihat panduan fasilitator. Untuk mengulas pekerjaan awal dan membaca materi pelatihan, lihat ringkasan kursus.
ReplyDeleteBazı europe kadınlarının avrupalı sikişmelerine porntube yardımcı olacaktır bakıldığı zamanlarda.
Free credit, many promotions Easy to play, easy to break. A good quality website guarantees a lot of fun and games.
ReplyDeletebetflix789