Technical Documentation Copy and Paste Kit

Penerangan

Tidak, kit ini tidak akan menulis manual pengguna anda yang seterusnya atau sistem bantuan dalam talian anda yang seterusnya untuk anda. Walau bagaimanapun, kit ini akan membantu anda menulis dokumentasi teknikal anda dengan sedikit usaha, dan ia akan membantu anda menghasilkan dokumen yang mesra pengguna dan berkualiti tinggi.

Kit ini memberikan anda perkara-perkara yang tidak diberikan oleh editor teks anda, alat pengarang bantuan atau sistem pengurusan kandungan: pengetahuan dan panduan untuk mencipta bantuan pengguna berkualiti tinggi.

Walau bagaimanapun, tidak seperti kebanyakan buku teks mengenai penulisan teknikal, kit ini tidak memberikan perincian teori yang panjang. Ia memberikan cadangan praktikal dan contoh yang anda boleh ingat dengan mudah dan menyesuaikan diri dengan kerja anda sendiri.

Kit meliputi:

* reka bentuk visual (susun atur) dokumen anda

* struktur dokumen anda

* cara menulis arahan biasa yang difahami oleh setiap pengguna

Anda tidak perlu menjadi pereka bentuk untuk melaksanakan cadangan reka bentuk dan anda tidak perlu menjadi ahli bahasa untuk memahami peraturan penulisan. Semua cadangan disertakan dengan contoh yang menarik.

Kit ini ditulis dalam bahasa Inggeris yang jelas dan ringkas yang boleh anda fahami dengan mudah walaupun anda bercakap bahasa Inggeris sebagai bahasa kedua. Hampir semua peraturan adalah universal, jadi anda juga boleh menggunakan kit jika anda menulis dalam bahasa selain bahasa Inggeris.

Dalam Edisi Plus kit, anda dan pasukan anda boleh menambah konvensyen dan peraturan khusus syarikat anda sendiri. Mendapatkan panduan gaya penulisan interaktif profesional tetapi tersuai tidak pernah semudah ini. Anda bebas untuk mengawal siapa yang boleh mengedit peraturan: hanya anda, hanya ahli pasukan terpilih atau semua orang.