Kézikönyvek

A kézikönyv, ahogy itt meghatározzuk, a következők kombinációja:

• koncepció információ
• utasítás információ
• referencia információ

minden egy adott témára összpontosít, egy adott közönség igényeihez. Ha technikai írást tanulsz e könyv használatával, a kézikönyv projekted muszáj mindenféle formában vagy módon be kell vonni ezeket a három elemet. Továbbá, ezeknek az elemeknek természetes, logikus "illeszkedésnek" kell lenniük a kézikönyv projektedhez.

Biztosan nézd meg a példák.

NotebookLM által generált infográfia erről a fejezetről

Kézikönyv alapok

Koncepciók. A koncepcionális információk elmagyarázzák, hogyan működnek a dolgok, hogyan vannak összerakva. Bonyolultabb utasítások esetén ismerned kell néhány fogalmat, elméletet, hátteret, alapelvet az utasítások végrehajtásához. Gondolj arra a példára, amikor egy szoftverfunkció lehetővé teszi, hogy módosítsd vagy létrehozd a saját színedet. Valami ilyesmivel, mint a Photoshop, Illusztráció, CorelDraw vagy Paint Shop Pro, ezt—a tényleges gombokat és csúszkákat— könnyű használni. De megérteni, hogy mi a színárnyalat, intenzitás, fényerő, telítettség, sűrűség, kontraszt, RGB—az nehéz. Ismerned kell a számítógépes színelméletet, hogy létre tudd hozni a szükséges színt.

Fontolj meg egy másik példát: egyszerű Linux fájlrendszer parancsok—ls, cd, cp, mv, pwd. E parancsok használatához meg kell értened, mik azok a fájlok és könyvtárak, és valószínűleg azt is, hogy mi az operációs rendszer, valamint a zsargonokat. Valójában nem tudod megérteni, hogyan használd ezeket a parancsokat—ha nem követed a használatukra vonatkozó utasításokat—amíg nem érted ezeket az alapfogalmakat.

Utasítások. Ha érted az alapvető fogalmakat, akkor intelligensen tudod követni a lépésről lépésre haladó eljárásokat. Az utasítások azok a jól megszokott, számozott listák, amelyek gondosan végigvezetnek egy eljáráson. Az utasítások mindenhol ott vannak, a termékcsomagoláson, a háztartási gépek és számítógépek használati útmutatójában.

Hivatkozás. Az utolsó információs kategória a keresési információkat vagy gyorsreferencia információkat foglalja magában. Ha követted a fálrendszer példa fent, először meg kellett tanulmányoznod és megértened a fájlok, könyvtárak, helyettesítő karakterek fogalmait. Utána követni és megérteni tudtad a könyvtárak megváltoztatására, fájlok másolására, törlésére vagy mozgatására vonatkozó utasításokat. Egy idő után azonban már nincs szükséged az utasításokra, de időnként különleges igényeid merülnek fel, amelyek nincsenek lefedve az utasítási részben, vagy nem emlékszel bizonyos eljárásokra, amelyek ott szerepeltek. Ez az idő, amikor alapvető referencia információra van szükséged: csak elmégy abba a részbe, és gyorsan megnézed.

És így, miután több idő telt el, már nincs szükséged sem a fogalmak, sem az instrukciók szekcióra: annyira hozzászoktál ezekhez a eljárásokhoz, hogy már fejből tudod őket. De időnként elfelejtesz egy kis részletet, vagy van egy különleges feladat, amit még sosem csináltál —, akkor nézel a referencia részhez. Valószínűleg le is tépheted a fogalmakat és instrukciókat, és eldobhatod őket. Csak a referencia részre van szükséged.

Kézikönyv Formátum és Stílus

Egy műszaki írási kurzus során, amely ezt a könyvet használja, elvárható, hogy kövesse a címsorok, listák, értesítések, grafikák, táblázatok, dokumentáció és bevezetők használatára vonatkozó speciális irányelveket:

Kézikönyv prototípus. Az alábbi linken egy példányt talál a kézikönyvről. Minden szükséges oldal megtalálható jó formátumban. A Word dokumentumban szereplő bekezdés- és karakterstílusok megkönnyítik a munkáját, és néhány professzionális készséget adnak a repertoárjához.

Kézikönyv prototípus

Tartalom prototípus. A tartalomjegyzék prototípusa különösen hasznos: megadja a Word stílusokat, hogy professzionális megjelenésű TOC-t készíthess. Nehéz elérni a bal- és jobb igazítást, valamint a vezető pontokat:

Tartalomjegyzék prototípus

Kézikönyv Példák

Itt van néhány link a kézikönyv példákhoz. Legyél tudatában, hogy az példákban vannak problémák, amelyeket többségükben kommentáltam. Néhány ezek közül határeset kézikönyv. Számomra egy kézikönyvet az határoz meg, hogy van benne fogalmi megbeszélés, útmutatások és referencia információk.

Győződj meg róla, hogy megnézed a példák.

AI Útmutatók Kézikönyvekhez

A listaellenőrzők, amelyeket jellemzően nem olvasnak el, módosításokkal AI promptok forrásaként használhatók. Másolja a következőt, illessze be egy AI rendszerbe, például a Google Gemini-be, és nézze meg, mit hagyott ki.

Megjegyzés: A techdocs vagy annak komponensei tartalmára, formátumára, stílusára vonatkozó összes hivatkozás megtalálható a online műszaki írás tankönyv.

Hamarosan!

Megerőltetném a véleményed, reakcióid, kritikáid erről a fejezetre: a válaszod—David McMurrey.