Az utasítások írásakor kerülje a meggyőző nyelvezetet, és alkalmazzon feladatalapú megközelítést. Tartsa az írást tömörnek és világosnak, és összpontosítson arra, hogy lehetővé tegye a felhasználó számára a feladat sikeres elvégzését.

Általánosságban az alábbi irányelveket kövesse:

Összefoglaltság és egyértelműség

A mondatok legyenek rövidek és érthetőek. Amikor csak lehetséges, használjon általános terminológiát. Kerülje az idiómák, a szleng, a zsargon, a becenevek, a rövidítések és a rövidítések használatát. Ha mégis olyan terminológiát használ, amely új vagy zavaró lehet, akkor az utasításban való első megjelenésekor egyértelműen határozza meg az egyes kifejezéseket.

A közönség

Az utasítások megírásakor fontos ismernie a közönségét, hogy minden szükséges információt tartalmazzon, és kizárja a felesleges információkat. A célközönség ismerete lehetővé teszi, hogy ésszerű és jól megalapozott feltételezéseket tegyen a célközönség valószínűsíthető háttere, tapasztalata és a témában való jártassága alapján. Ha például a közkönyvtár helyi fiókjában dolgozó nyugdíjasok egy csoportja számára ír utasításokat, nem biztos, hogy feltételezheti, hogy ismerik egy adott szoftveralkalmazás megnyitásának alapjait. Ha azonban egy szakmai szervezeten belüli szoftverfejlesztők csoportja számára ír utasításokat, akkor nyugodtan feltételezheti, hogy ismerik egy adott szoftveralkalmazás megnyitásának alapjait.

Az utasításokba belefoglalandó és belőlük kizárandó információk meghatározásakor fontos, hogy világosan meghatározzuk, ki a célközönség, és milyen valószínűsíthető jártassággal rendelkeznek az utasítás témájában és a kapcsolódó háttérinformációkban.

Ha a közönség valószínűleg széles körű tapasztalattal és tudással rendelkezik, amely különböző szintű ismereteket és szakértelmet foglal magában, különböző technikákat alkalmazhat annak érdekében, hogy az egyes utasítások tömörek és egyetlen feladatra összpontosítsanak, ugyanakkor a szükséges információkat is megadják. Például külön utasításokat készíthet az előfeltételekkel kapcsolatos információkhoz, és biztosíthatja a közönség számára a külön utasítások gyors és egyszerű elérésének lehetőségét (hiperhivatkozások, mellékletek stb. révén).

Grafika

A képek hangosabban beszélnek, mint a szavak. A gondolatokat közvetítő grafikák hozzáadása hatékonyabb lehet, mint maguk a szavak. A jól illusztrált és az írásos utasításokat kísérő utasítások általában nagyon sikeresek. Ez egy plusz szintet ad a megértéshez, és lehetővé teszi az olvasó számára, hogy átfusson vagy hibaelhárítást végezzen, ha problémák merülnek fel. A képek egy további dimenziót adnak hozzá, amely lehetővé teszi az olvasó számára, hogy vizualizálja a végterméket. A grafikák használatakor is tekintettel kell lennie azokra, akik vizuálisan tanulnak, és a grafikákat hozzá kell igazítania.

Bár a képek nagyszerűek, óvatosnak kell lennie, hogy ne tartalmazzon olyan fényképeket vagy illusztrációkat, amelyek zavaróak vagy nem kapcsolódnak a tényleges írott utasításokhoz. Ha rossz képet párosít az utasításokkal, akkor stresszt okozhat az olvasónak, vagy zavart okozhat, amikor megpróbálja megfejteni, hogy mire gondol.

Azzal is számoljon, hogy a képek készítésekor ügyeljen arra, hogy a terület jól megvilágított legyen, és a képek világosak és világosak legyenek. A sötét vagy homályos képeket gyakran nehéz követni. A félreértések elkerülése érdekében ügyeljen arra, hogy a témát minden alkalommal ugyanabban a tájolásban fényképezze, és fontolja meg állvány használatát.

A méret is fontos, amikor a képeket használjuk az utasításokban. Egy túl kicsi kép ugyanolyan haszontalan, mint egy elmosódott kép.

Az erőteljes és érthető megjelenítés érdekében az egyes lépésekhez tartozó szövegnek és grafikának egyértelműen kapcsolódnia kell az utasítás adott lépéséhez.

Formatálás

Ne feledje, hogy az olvasók az utasítás végigolvasása közben ténylegesen elvégzik a feladatot. Ezért ne használjon tömör, apró, nehezen megfejthető szövegtömböket. Ügyeljen arra, hogy olyan dizájnt és elrendezést hozzon létre az utasítások oldalához, amely lehetővé teszi a könnyű olvashatóságot és esztétikai minőséget ad hozzá. Az oldal egyszerű, de meghatározott hierarchiával rendelkező tartása segíteni fogja az olvasót az utasítások lépéseinek elvégzésében.

Az oldal tervezésekor a szilárd hierarchia fontos a beolvashatóság szempontjából. A félkövér címsorok, dőlt betűk és római számok használata segíti az olvasót abban, hogy könnyen megtalálja a helyét, és segíti az általános vizuális megjelenést.

Sorrend

Nagyon fontos, hogy az utasításokat logikusan felépítve tervezze meg. Ügyeljen arra, hogy az első oldalon egyértelműen fogalmazza meg a problémát. A problémákat konkrét lépések sorozata kövesse, amelyek részletezik a javasolt probléma megoldását. A technikai utasításoknak logikusan kell haladniuk. Például egy asztal összeszerelésekor nem lenne jó, ha az utolsó simításokat azelőtt végezné el, mielőtt az összes csavart a helyére tette volna. Mint már említettük, szükség esetén egyértelmű grafikáknak is kell lenniük, hogy egyértelművé tegyék a műveletet. Ne feledje, egy kép többet ér ezer szónál.

Tesztelés és ellenőrzés

Mindannyian tudjuk, hogy az utasításokat nehéz megírni, és hogy néha papíron jól hangzik, de amikor ténylegesen megpróbálod használni az utasításokat, előfordulhat, hogy a megfogalmazásodnak mások számára nincs értelme. Ne feledje, hogy ami az Ön számára hétköznapi vagy nyilvánvaló lehet, az az olvasóit zavarba ejtheti, ezért ismerje meg a célközönségét. Amellett, hogy saját magadon teszteled az utasításokat, kérj meg valakit, aki semmit sem tud a termékedről. Ezt nevezik használhatósági tanulmánynak. Jegyezze fel, hogy mi működött és mi nem, majd ennek megfelelően dolgozza át az utasításait. Hosszú távon minél több ember teszteli az utasításait, annál hatékonyabb lesz a végleges készlet.