A műszaki kézikönyv írása egy egyszerű feladat, amely a lépések megszervezését és a világos, tömör megfogalmazást jelenti. A műszaki kézikönyv célja, hogy tájékoztatást nyújtson arról, hogyan végezze el a műveletet a legkisebb lépésekben és a lehető legegyszerűbb módon. A műszaki kézikönyvek gyakran sok ember együttműködésével járnak, beleértve a tárgyi szakértőket, szerkesztőket és technikai írókat. Mivel a műszaki kézikönyvek is folyamatosan felülvizsgálhatók és frissíthetők, az érintett felek közötti kommunikáció döntő fontosságú a kézikönyv kidolgozása szempontjából.
Határozza meg a műszaki kézikönyv stílusát azáltal, hogy létrehoz egy egyszerűsített stílus útmutatót, vagy követ egy meglévő stílus útmutatót, például a Microsoft Style Guide for Technical Manuals-t. A stílusvezető segít a kézikönyv vázának létrehozásában, és biztosítja a következetességet.
Írja be az eljárás lépéseit egy igével kezdődően. Ha konzultációra van szükség a lépések írásához, interjúhoz és a témakör szakértőinek kérdéseivel. Ez biztosítja az eljárások érvényességét; ellenkező esetben a lépések nem lehetnek logikusak és / vagy nem megfelelőek. A lépéseket logikailag meg kell rendezni, és logikai fejezetekre vagy felosztásokra kell osztani.
Adjon hozzá grafikákat és illusztrációkat a szükséges lépésekhez. Ne feledje, hogy minden grafikához / ábrához adjon meg számjegyeket és címeket.
Hozzon létre egy tartalomjegyzéket és egy indexet az egyszerű hivatkozás érdekében.
Adjon hozzá egy változási naplót vagy frissítési lapot, amely rögzíti a változásokat és frissíti a kézikönyvet a későbbi módosítások és kiadások számára. A műszaki kézikönyveket mindig a technikai írótól eltérő személynek kell szerkesztenie, lehetőleg egy profi szerkesztővel.
