Technical Documentation Copy and Paste Kit

Deskripsi

Tidak, kit ini tidak akan menulis panduan pengguna berikutnya atau sistem bantuan online berikutnya untuk Anda. Namun, kit ini akan membantu Anda untuk menulis dokumentasi teknis Anda dengan sedikit usaha, dan ini akan membantu Anda menghasilkan dokumen berkualitas tinggi yang ramah pengguna.

Kit ini memberi Anda hal-hal yang tidak disediakan oleh editor teks, alat bantu penulisan, atau sistem manajemen konten Anda: pengetahuan dan panduan untuk membuat bantuan pengguna berkualitas tinggi.

Namun, tidak seperti banyak buku teks tentang penulisan teknis, kit ini tidak memberikan elaborasi teoretis yang panjang. Ini memberikan rekomendasi dan contoh praktis yang dapat Anda ingat dengan mudah dan sesuaikan dengan pekerjaan Anda sendiri.

Kit ini mencakup:

* desain visual (tata letak) dokumen Anda

* struktur dokumen Anda

* cara menulis instruksi sederhana yang dipahami setiap pengguna

Anda tidak perlu menjadi seorang desainer untuk menerapkan rekomendasi desain, dan Anda tidak perlu menjadi ahli bahasa untuk memahami aturan penulisan. Semua rekomendasi datang dengan contoh yang menarik.

Kit ini ditulis dalam bahasa Inggris sederhana dan sederhana yang dapat Anda pahami dengan mudah bahkan jika Anda berbicara bahasa Inggris sebagai bahasa kedua. Hampir semua aturan bersifat universal, jadi Anda juga dapat menggunakan kit jika Anda menulis dalam bahasa selain bahasa Inggris.

Dalam Kit Edisi Plus, Anda dan tim Anda dapat menambahkan konvensi dan peraturan khusus perusahaan Anda sendiri. Mendapatkan panduan gaya penulisan interaktif yang profesional namun khusus tidak pernah semudah ini. Anda bebas mengontrol siapa yang dapat mengedit aturan: hanya Anda, hanya anggota tim yang dipilih, atau semua orang.