Artikel ini dipersembahkan oleh Kebaya Diva.
Baru tech-writing, atau berpikir untuk memulai? Kunci sukses adalah menyadari bahwa para penulis teknologi adalah kejahatan yang diperlukan.
Penulis teknis diperlukan karena seseorang harus menulis doco pengguna. Para pemrogram dan manajer pasti tidak mau. Ini sebenarnya adalah bagian dari alasan bahwa Anda juga jahat. Menurut pengalaman saya, sebagian besar pemrogram dan manajer berpikir bahwa mereka bisa menulis manual jika mereka menginginkannya ... mereka tidak mau melakukannya. Mereka mungkin tidak menulis semua "bunga" seperti para penulis teknologi, tapi apa yang mereka tulis itu benar.
Sayangnya, itu cukup sering semua yang penting bagi programmer dan manajer. Ada perasaan dalam lingkungan perangkat lunak yang akurasi = kualitas. Analisis audiensi, keterbacaan dokumen, konsistensi, kegunaan, suara aktif dan pasif, koma dalam daftar tiga item atau lebih ... Semua hal ini relatif tidak penting bagi semua orang kecuali penulis teknologinya. Oh ... dan pengguna.
Di dunia di mana akurasi itu penting, banyak yang melewati kepala boneka itu. Saya tidak tahu apakah itu keangkuhan intelektual, tapi pemrogram dan manajer tampaknya berpikir bahwa jika mereka memahaminya, sebaiknya pengguna. Tidak masalah apakah mereka melakukannya atau tidak? Mereka HARUS! Pengguna bodoh Mungkin ini balas dendam terakhir geek ...
Dokumen Anda bisa 100% akurat, tapi jika penonton tidak bisa membacanya, Anda sudah menyia-nyiakan waktumu.
Jadi kenapa tidak ada yang tahu ini? Mereka lakukan Itulah bagian yang aneh. Secara teori, semua orang setuju dengan Anda, hanya dalam praktiknya Anda mendapati diri Anda dalam kedinginan. Saya tidak tahu mengapa ini terjadi. Mungkin itu karena kebanyakan dari mereka belum pernah melakukan tech-writing.
Jadi, para penulis teknologi menghabiskan waktu terlalu lama untuk mengkhawatirkan hal-hal yang tidak penting. Dan mereka mengganggu para pemrogram dan manajer dengan hal-hal yang tidak penting. Tapi itu penting. Kalau tidak, mengapa Anda dipekerjakan? Mungkin tidak adanya logika sederhana sirkuit pendek otak mereka. Siapa tahu?
Apa yang bisa kita dapatkan dari ini adalah bahwa ada perasaan bahwa para penulis teknologi membuang waktu, dan akibatnya, mereka cukup banyak berada di dasar tumpukan di dunia perangkat lunak. Saya pikir analogi yang baik adalah cara orang kaya melihat orang miskin. Makhluk kecil yang kotor ... seandainya kita bisa melakukannya tanpa mereka ...
Tapi ada sisi atas. Saya tidak ingin Anda berpikir itu semua buruk.
Berada di bagian bawah tumpukan memiliki kelebihan. Anda bisa pergi tanpa disadari selama bertahun-tahun jika Anda mau. Jika Anda belum melihat filmnya, Office Space, Anda harus menyewa itu. Ada sedikit cowok gila yang "dilepaskan" bertahun-tahun yang lalu. Masalahnya, tak ada yang memberitahunya, dan karena kesalahan dalam penggajian dia masih dibayar. Tidak ada yang menyadarinya.
Menjadi seorang penulis teknik agak seperti itu.
Ketika saya mengelola tim doco, kata favorit saya adalah "Yang harus kita lakukan adalah mengelola harapan dan komitmen kita". Karena pemrogram dan manajer mengundurkan diri dari kenyataan bahwa mereka tidak tahu apa yang terjadi di tim doktor, terkadang ada godaan untuk mengendur. Jangan menyerah pada godaan ini !!! Jika Anda pernah tertangkap, melakukannya, akan seperti anak laki-laki yang menangis serigala - mereka tidak akan pernah mempercayai perkiraan Anda lagi!
Resiko lainnya adalah Anda akan kehilangan rasa urgensi Anda. Dan itu adalah bagian besar dari apa yang membuat seorang pekerja yang baik. Anda harus sangat ketat dalam mengelola komitmen Anda. Ini membutuhkan kedisiplinan, karena terkadang sepertinya Anda satu-satunya yang peduli, tapi Anda harus melakukannya.
Satu hal yang harus Anda sadari meskipun, adalah bahwa rata-rata penulis teknologi dalam perangkat lunak hanya menghabiskan sekitar 50% waktu penulisannya. Sisa waktu Anda dihabiskan untuk merencanakan, memecahkan masalah, memperbaiki komputer Anda, meneliti, mewawancarai pemrogram, menulis pracs kerja ...
Bagaimanapun, saya selalu menganggapnya seimbang.
Saat itulah saya mulai mengelola tim sehingga bagian bawahnya benar-benar terjatuh. Kemudian persentase turun menjadi sekitar 10-20%. Ada kalanya aku akan pergi berbulan-bulan tanpa meminta bantuan sama sekali. Itu bisa sangat menyebalkan, terutama jika Anda tidak terlalu suka mengelola.
Sekarang mengelola tech-writers dalam software adalah hal yang menarik. Seperti kebanyakan posisi manajemen teknologi, Anda agak jatuh ke dalamnya, karena Anda adalah orang yang paling tua / berpengalaman di perusahaan. Sayangnya, itu tidak memenuhi syarat Anda untuk menjadi manajer. Perusahaan perangkat lunak terkenal karena membuang orang ke dalam peran manajemen tanpa pelatihan atau dukungan nyata.
Saya tidak benar-benar punya saran untuk Anda di sini. Jika itu akan terjadi, itu akan terjadi. Sadari saja, dan ketahuilah bahwa jika Anda termasuk dalam peran manajemen, itu akan menjadi sulit. (Itu tidak berarti bahwa itu tidak akan memuaskan meskipun ...)
Hal yang ironis adalah aspek tersulitnya adalah staf Anda berteriak pada Anda untuk mengubah sistem. "Para pemrogram tidak menjawab pertanyaan kami!" "Tidak ada pekerjaan saya yang telah diperiksa selama 2 bulan terakhir ini!" "Manajer proyek hanya menyuruh saya untuk melupakan kualitas!" Sayangnya, penulis teknik yang belum berpengalaman seringkali cukup naif. untuk berpikir mereka bisa mengubah sistem.
Begitu Anda menjadi manajer, Anda tahu tidak bisa melakukannya. Tunggu sebentar ... Mungkin apatis adalah apa yang memenuhi syarat untuk menjadi manajer ... Hmmmm. Bagaimanapun, nasehat saya jangan terlalu memaksakan diri. Anda akan membuat hidup sulit bagi manajer Anda, dan memberi diri Anda reputasi buruk. Kenali Anda adalah kejahatan yang penting, dan kerjakan dalam batasan itu. Tech-writing bisa sangat menyenangkan. Dan jangan sampai ada yang bilang itu tidak kreatif. Mencoba memikirkan cara untuk menggambarkan apa yang terjadi di bidang Nama tanpa hanya mengatakan "Masukkan nama" adalah benar-benar membingungkan!
