Kézikönyvek

Egy kézikönyv, ahogyan itt definiáljuk, a következők kombinációja:

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

mindegyik egy adott témára és egy meghatározott közönség igényeire összpontosít. Ha ezen a könyvön alapuló műszaki írási kurzust veszel, a kézikönyvprojekted kell tartalmazzon valamilyen formában mindhárom elemet. Sőt, ezeknek az elemeknek természetes, logikus módon kell illeszkedniük a kézikönyvprojektedhez.

Mindenképp nézd meg a példák.

A NotebookLM által generált infografika erről a fejezetről

Kézikönyv alapjai

Fogalmak. A koncepcionális információ elmagyarázza, hogyan működnek a dolgok, hogyan vannak összeállítva. Bonyolultabb utasítások esetén bizonyos fogalmakat, elméleti ismereteket, háttértudást és alapelveket kell ismerned az utasítások végrehajtásához. Vegyük példának azt a szoftverfunkciót, amely lehetővé teszi, hogy módosítsd vagy létrehozd a saját színedet. Olyan programok, mint a Photoshop, Illustration, CorelDraw vagy Paint Shop Pro használata ehhez—a tényleges gombokkal és csúszkákkal— egyszerű. De az árnyalat, az intenzitás, a fényerő, a telítettség, a sűrűség, a kontraszt, az RGB— megértése már nehéz. Ismerned kell a számítógépes színelméletet ahhoz, hogy létrehozd a szükséges színt.

Vegyünk egy másik példát: egyszerű Linux fájlrendszer-parancsok—ls, cd, cp, mv, pwd. Ezeknek a parancsoknak a használatához meg kell értened, mik azok a fájlok és könyvtárak, és valószínűleg azt is, mi az az operációs rendszer, valamint a helyettesítő karakterek. Valójában nem tudod megérteni, hogyan kell használni ezeket a parancsokat—és követni az utasításokat azok használatával—hacsak nem érted meg ezeket az alapfogalmakat.

Utasítások. Ha megérted az alapvető fogalmakat, akkor értelmesen követheted a lépésről lépésre haladó eljárásokat. Az utasítások azok a jól ismert, számozott listák, amelyek gondosan végigvezetnek egy eljáráson. Az utasítások mindenütt megtalálhatók: a termék csomagolásán, a készülékekhez és számítógépekhez mellékelt használati útmutatókban.

Referencia. A legutolsó információkategória a kereső- vagy gyorsreferencia-információkat foglalja magában. Ha követted a fenti fájlrendszeres példát, először tanulmányoznod és meg kellett tanulnod a fájlok, a könyvtárak és a helyettesítő karakterek fogalmát. Ezután követni és megérteni tudtad az utasításokat a könyvtárak közötti váltáshoz, a fájlok másolásához, törléséhez vagy áthelyezéséhez. Kis idő múlva azonban már nincs szükséged az utasításokra, de időről időre felmerülhetnek olyan különleges igények, amelyek nincsenek lefedve az utasítások között, vagy nem emlékszel bizonyos, az utasításokban tárgyalt eljárásokra. Ilyenkor van szükséged alapvető referencia-információra: egyszerűen odalépsz ahhoz a részhez, és gyorsan utánanézel.

És így, idővel már egyikre sem lesz szükséged — sem a fogalmi szakaszra, sem az utasítások szakaszára: annyira hozzászoktál ezekhez az eljárásokhoz, hogy kívülről ismered őket. De időnként elfelejtesz egy apró részletet, vagy van egy különleges feladatod, amit még sosem csináltál — ekkor a referenciarészhez nyúlsz. Valószínűleg le is téphetnéd a fogalmi és az utasítások szakaszát, és eldobhatnád őket. Mindig csak a referenciarészre lesz szükséged.

Kézikönyv formátuma és stílusa

Egy, ezt a könyvet használó műszaki írási kurzuson elvárhatják, hogy a címsorok, listák, közlemények, grafikák, táblázatok, dokumentáció és bevezetők használatára vonatkozó konkrét irányelveket alkalmazd:

Kézikönyv-prototípus. Az alábbi linkről letöltheti a kézikönyv mintapéldányát. Tartalmazza az összes szükséges oldalt megfelelő formátumban. A Word-dokumentum bekezdés- és karakterstílusokat tartalmaz, amelyek megkönnyítik a munkáját, és néhány szakmai készséggel bővítik a repertoárját.

Kézikönyv prototípus

Tartalom prototípusa. A tartalomjegyzék prototípusa különösen hasznos: megadja a Word-stílusokat egy professzionális megjelenésű tartalomjegyzék elkészítéséhez. Nehéz eltalálni a bal- és jobbra igazítást és a vezetőpontokat:

Tartalomjegyzék prototípus

Kézikönyv példák

Itt van néhány link kézikönyvpéldákhoz. Vegye figyelembe, hogy a példákban vannak problémák, amelyek többségére megjegyzést fűztem. Ezek közül néhány határeset kézikönyvnek számít. Számomra kézikönyvvé az teszi az anyagot, ha jelen vannak benne a fogalmi megbeszélések, az útmutatások és a hivatkozási információk.

Mindenképpen nézd meg a példák.

MI-utasítások kézikönyvekhez

Az ellenőrző listákat, amelyeket általában nem olvasnak el, némi módosítással fel lehet használni mesterséges intelligenciának szánt promptok forrásaként. Másolja ki a következőt, illessze be egy olyan mesterséges intelligencia-rendszerbe, mint a Google Gemini, és nézze meg, mit mulasztott el.

Megjegyzés: Minden hivatkozás a techdocs tartalmára, formátumára, stílusára vagy annak összetevőire megtalálható a online műszaki írás tankönyv.

Hamarosan!

Szívesen fogadnám a gondolatait, reakcióit és kritikáját ezzel a fejezettel kapcsolatban: a válaszod—Dávid McMurrey.