Gyakran kitöltött zsargonnal, betűszóval és irányokkal, amelyek megértik a Ph.D.-t, a szoftver felhasználói kézikönyvét néha a fejlesztő, hanem a felhasználó szemszögéből írják. Ennek eredményeképpen az útmutató feltételezéseket készíthet az olvasó képességszintjéről, amelyek gyakran hibásak. A jó felhasználói kézikönyv írásának első lépése az, hogy a tényleges írási folyamat a lehető legtávolabb legyen a mérnököktől.
A szoftverfejlesztő többet tud, mint bárki, ami a szoftvert működteti, de ez nem jelenti azt, hogy a fejlesztőnek meg kell írnia az útmutatót. Éppen ellenkezőleg, ez külön hátrány. A szoftver belső működésének mélyebb megértésénél fontosabb, hogy megértsük, hogy ki lesz a végfelhasználó, milyen az oktatási szintje, és hogyan fogja a végfelhasználó használni a szoftvert. A legtöbb esetben a végfelhasználóknak nem kell tudniuk a programozás finomabb pontjait és a szoftver back-end működését - csak meg kell tudniuk, hogyan kell használni a munkájukat könnyebbé tenni.
Felhasználói tesztelés
A felhasználói kézikönyvnek nagyrészt feladat-orientáltnak kell lennie, nem pedig erősen leíró jellegűnek. Mivel a kézikönyvet azért írták, hogy segítse a felhasználókat abban, hogy megértsék, hogyan kell végrehajtani a konkrét feladatokat, az írónak meg kell értenie ezeket a feladatokat is, és ennek eredményeképpen minden egyes különálló lépés teljesítése elengedhetetlen. Az írónak nem kell feltétlenül tudnia, hogyan alakították ki a programot egy tervezési vagy fejlesztési szempontból, de elengedhetetlen, hogy erősen megismerjük az összes jellemzőjét. Az egyes feladatok végrehajtása során időbe telik minden egyes lépés írásához, beleértve a kattintásokat, a legördülő menüket és egyéb műveleteket.
Az interjú folyamat
Habár a fejlesztő nem írja le a kézikönyvet, ő még mindig értékes erőforrás lesz az író számára, és az írás megkezdése előtt megtervez egy kickoff találkozót az író, a fejlesztő és a mérnökök, valamint a potenciális végfelhasználók között, hogy segítsen tájékoztatni az információt. író munkája a kezdetektől fogva. A tárgyi szakértőkkel és mérnökökkel folytatott interjúkat fel kell jegyezni, a későbbi hivatkozásokhoz készült átiratokkal.
Képek
A felhasználói kézikönyv nem lehet túlságosan szöveges. Inkább a grafikák és a képernyő klipek liberális használatát foglalja magába. A cselekvés leírása sokkal világosabb, szöveges irányokkal együtt, egy olyan képernyő klipszel együtt, amely egyértelműen mutatja ezt az irányt. A nézetek előtt és után is jelenítse meg, hogy milyen módon néz ki a képernyő, mielőtt elkezdené az egyes műveleteket, és mi történik a művelet végrehajtása után. Egy egyszerű képernyőfelvétel segédprogram, mint például a Microsoft Windowsban található Snipping eszköz, jól működik ezeknek a képeknek a rögzítéséhez. Győződjön meg róla, hogy minden képet megszámol, és tartalmazzon egy rövid leírást. Közvetlenül helyezze el azt a bekezdést, amely először bevezeti a képen látható fogalmat.
formázása
A műszaki dokumentumokban való egyértelmű kommunikáció megköveteli a tervezés és a szabványok gondos betartását az útmutatóban. A bemutatás, a nyelv és a nómenklatúra szabványai segítenek elkerülni a zavart. A sablonok rendelkezésre állnak és jó kiindulópontot jelenthetnek az egységességhez, bár ezek mindenképpen igazodhatnak az egyes helyzetekhez. Egy hüvelykes margó használata egyetlen oszlopkal leginkább megfelel a grafika hozzáadásának szükségességének; a kétoszlopos beállítás túlságosan zsúfoltnak tűnhet, és zavaró képeket hozhat létre.
Verzió és követés
Valamennyi más dokumentumtípusnál a szoftver használati útmutatója valószínűleg több ismétlésen megy keresztül, mielőtt befejeződik, és valószínűleg több érdekelt fél is felülvizsgálati folyamatot hajt végre. A Microsoft Word programban a Track Changes szolgáltatás használata egyszerű módja annak, hogy nyomon követhesse az egyes személyek megjegyzéseit és változásait. Több változat létrehozása az egyes felülvizsgálati ciklusok után, mindegyik más fájlnévvel is segíti a folyamatot, és gondoskodik arról, hogy minden érdekelt fél elégedett legyen a végeredménnyel.
