A műszaki írók különböző típusú dokumentációkat készítenek, például felhasználói kézikönyveket, API dokumentációt, “Hogyan kell” útmutatókat és így tovább. Írtam egy cikket arról, hogyan kell felhasználói kézikönyvet írni, ezért ma egy ‘Hogyan kell’ útmutató készítéséről fogok mesélni.
Amikor azt a feladatot kapod, hogy készíts egy útmutatót, az első lépésed a tervezés legyen. A következőket kell tenned:
Tudd meg a célközönségedet
Amikor elkezded írni az útmutatót, világosan meg kell értened, hogy ki a célközönséged. Milyen korúak, milyen a hátterük és így tovább. Ez fogja meghatározni a “Hogyan kell”-kalauzod stílusát a legalapvetőbb szinten – a használt nyelvezet összetettségét, a kifejezések számát és sok más jellemzőt.
Kutatás a folyamatról
Azt ajánlom, hogy olvass másoknak a “Hogyan kell”-kalauzok írása során szerzett tapasztalatairól. Ez segít abban, hogy világos képet kapjon a jövőbeli munkáról, és mások megközelítéseit beépítheti a saját munkafolyamatába. Írtam például Amrute Ranade műszaki írói folyamatáról, a cikket itt olvashatod: ‘Nagyszerű műszaki írói folyamat’. Tehát te is használhatod ezt a módszert, hogy megkönnyítsd a műszaki írásodat.
Haszonanyagok gyűjtése
Az írás megkezdése előtt gyűjtsd össze azokat az anyagokat és információkat, amelyek segítenek a “hogyan kell” útmutató megírásában. Ez lehet egy termékkel kapcsolatos kiegészítő információ, más, hasonló termékekről szóló “hogyan kell” útmutatók vagy valami más.
Írd meg a “hogyan kell” útmutatót
Először is készíts tervet – könnyebb lesz megírni az útmutatót, ha vizualizálod azt. Mindezen előkészületek után legfőbb ideje elkezdeni az írást. Az útmutató készítése közben tartsa szem előtt a következő tippeket:
- Írjon egyszerű angol nyelven, hogy ugyanazt a nyelvet beszélje, mint az olvasói.
- A nyelvezetének mindig tömörnek kell lennie (például, “Válassza ki a lehetőséget” helyett “Ki kell választania a lehetőséget”).
- Készítsen számozott listákat a lépések strukturálására, ha a felhasználónak ki kell töltenie azokat
- Adjon hozzá vizuális tartalmat, például fényképeket, képernyőképeket és diagramokat.
- Bontja a tartalmat fejléces részekre, de írja meg őket világosan
- Ha vicceket akar használni, legyen óvatos: az emberek nem biztos, hogy megértik
- Adjon hozzá mini-TOC-okat, hogy a nagy témákat olvashatóbbá tegye.
A legfontosabb tipp a következő – a helyesírási és nyelvtani hibák elfogadhatatlanok a dokumentációban, ezért alaposan ellenőrizze az útmutatót. Itt van egy lista a legjobb ingyenes nyelvtani ellenőrző programokról. Emellett megkérhetsz valakit, hogy lektoráljon helyetted, vagy fordítva olvasd el a saját lépéseidet, hogy megbizonyosodj arról, hogy az írásod világos és egyszerű. Íme néhány további forrás a nagyszerű dokumentáció megírásához:
- Grammatikai könyvek műszaki íróknak
- Stíluskalauzok műszaki íróknak
Természetesen ez nem minden, amit a “Hogyan írjunk” útmutatók megírásáról tudni kell, de ezek a tippek szerintem a legfontosabbak. Remélem, segítenek neked.
Sok sikert az útmutatóíráshoz!