Paano Sumulat ng isang Technical Manual Mula sa Scratch

Anonim

Ang pagsulat ng isang teknikal na manu-manong ay isang tapat na gawain na nagsasangkot ng mga hakbang sa pag-aayos at paglikha ng malinaw at maigsi na mga salita. Ang layunin ng isang teknikal na manu-manong ay upang magbigay ng impormasyon kung paano magsagawa ng isang operasyon sa hindi bababa sa halaga ng mga hakbang at sa pinakamalinaw na posibleng paraan. Ang mga teknikal na manwal ay madalas na may kaugnayan sa pakikipagtulungan ng maraming tao, kabilang ang mga eksperto sa paksa, editor at teknikal na manunulat. Dahil ang mga teknikal na manwal ay maaari ding sumailalim sa pare-pareho na rebisyon at mga update, ang komunikasyon sa pagitan ng mga partido na kasangkot ay napakahalaga sa pag-unlad ng isang manu-manong.

Tukuyin ang estilo ng teknikal na manu-manong sa pamamagitan ng alinman sa paglikha ng isang pinasimple na gabay sa estilo o sa pamamagitan ng pagsunod sa isang umiiral na gabay sa estilo, tulad ng Microsoft Style Guide para sa Technical Manuals. Ang isang estilo ng gabay ay makakatulong sa paglikha ng balangkas ng manu-manong at matiyak ang pagkakapare-pareho.

Isulat ang mga hakbang para sa pamamaraan na nagsisimula sa isang pandiwa. Kung kailangan ang konsultasyon upang isulat ang mga hakbang, pakikipanayam at magtanong ng mga eksperto sa paksa. Titiyakin nito ang bisa ng mga pamamaraan; kung hindi, ang mga hakbang ay maaaring hindi lohikal at / o wala sa order. Ang mga hakbang ay dapat na lohikal na iniutos at pinaghiwalay sa lohikal na mga kabanata o dibisyon.

Magdagdag ng mga graphics at mga guhit sa mga hakbang na nangangailangan sa kanila. Tandaan na magdagdag ng numero ng numero at mga pamagat sa bawat graphic / ilustrasyon.

Gumawa ng isang talaan ng mga nilalaman at isang index para sa madaling reference.

Magdagdag ng pagbabago log o update sheet na nagtatala ng bawat pagbabago at i-update sa manu-manong para sa mga pagbabago at paglabas sa hinaharap. Ang mga teknikal na manwal ay dapat palaging i-edit ng isang tao maliban sa teknikal na manunulat, mas mabuti ng isang propesyonal na editor.