Bármilyen ötletes is lehet egy feltaláló, programozó vagy racionalizáló, alkotásait néha egyszerűen nem lehet rendeltetésszerűen felhasználni. Ennek oka a helytelenül elkészített használati útmutató vagy annak hiánya. De a leleményes feltalálók is olykor olyan utasításokat írnak, hogy a szűk szakembereken kívül senki sem tudja elolvasni ezeket a papírokat. Tehát hogyan kell megfelelően elkészíteni egy ilyen szükséges dokumentumot?
Szükséges
- - száz százalékos ismerete annak az eszköznek vagy szoftverterméknek, amelyhez a kézikönyvet írják;
- - ismeretek a nyelvészet területén;
- - írói képességek.
Utasítás
1. lépés
A felhasználói kézikönyv vagy más szóval a kezelési kézikönyv olyan dokumentum, amelynek célja, hogy segítséget nyújtson felhasználóinak egy adott rendszer használatához. A felhasználói kézikönyv összeállításához száz százalékosan ismernie kell a leírt rendszert, de egy tudatlan diák szemével kell néznie. Tegyük fel, hogy felhasználói kézikönyvet írtak egy olyan szoftver segédprogramhoz, amelynek még nincsenek analógjai. Képzelje el, hogy most először használja ezt a programot. Honnan indulsz? Mit kell először tudni? Rendezze ezeket az ismereteket fontos kategóriákba.
2. lépés
A létrehozásával kapcsolatos összes információ csoportokra osztásával elkészítette a felhasználói kézikönyv megírásának tervét. Kezdje a semmiből leírni a munkáját a programban, így a legnehezebb részleteket, például a funkciók újraprogramozását vagy a kritikus hibák kezelését hagyja utoljára. Ebben a szakaszban készen kell állnia a felhasználói kézikönyv tartalmára - a dokumentum egyik szükséges részére.
3. lépés
Ha az Ön által létrehozott kézikönyvet egy nagyvállalatban kívánják használni, akkor figyeljen az ott elfogadott vállalati szabványokra. Például sok orosz vállalatnál a felhasználói kézikönyveket nem fogadják el szemléltető támogatás nélkül, más szóval képek, amelyek megmagyarázzák az írottakat. A tartalom mellett a felhasználói kézikönyvnek tartalmaznia kell további kötelező részeket is: - Megjegyzés, vagyis a kézikönyv és a leírt termék általános céljainak magyarázata; - Bevezetés, amely leírja a felhasználói kézikönyvvel kapcsolatos dokumentumokat és hogyan a kézikönyv használata; - a termék használatának különböző szakaszaiban, például az első lépésekben, a javításban vagy a karbantartásban kifejtett részei; - a gyakran feltett kérdések és a rájuk adott válaszok részei; - szójegyzék vagy tárgymutató.
4. lépés
Általában egy műszaki író vesz részt a felhasználói kézikönyv létrehozásában - olyan személy, aki rendelkezik minden szükséges ismerettel mind a leírt nyelven, mind a leírt termékben. Képzés nélküli műszaki íróként néhány szabályt szem előtt kell tartani. Először is, nem szabad visszaélnie olyan speciális kifejezésekkel, amelyek a hétköznapi felhasználók számára nem érthetők. Másodszor, minden használt kifejezést részletezni és magyarázni kell. Harmadszor, a lehető legvilágosabban és tömörebben kell írnia. Végül a szakírónak képesnek kell lennie arra, hogy a saját szövegének hiányosságainak megismerése érdekében a hétköznapi felhasználó szemével nézhesse meg saját szövegét.
5. lépés
Jó, ha a felhasználói kézikönyv kész szövegét a gyakorlatban tesztelik, olyan személynek ajánlva, akinek semmi köze nem volt a leírt termékhez. Közös erőfeszítésekkel meg lehet szüntetni a dokumentum összes hiányosságát és buktatóját.
