A műszaki írás több, mint a televízió használatáról vagy javításáról szóló kézikönyvek megírása. Többféle dokumentumtípust is magában foglal, még a marketing dokumentumokat is. Olvassa el ezt a cikket, hogy többet megtudjon a műszaki dokumentációról; hasznos lesz a kezdő műszaki írók számára, akik el akarják dönteni, hogy milyen típusú dokumentáció lesz érdekes.

A használati útmutatók, a kézikönyvek, a “Hogyan kell” útmutatók és hasonlók a műszaki dokumentáció leggyakoribb típusai, és ezek jutnak mindig az emberek eszébe, amikor valaki azt mondja, hogy “műszaki dokumentáció”. Hadd írjak le néhány típust részletesen.

Kezelői útmutatók

A felhasználói útmutatók segítenek az embereknek egy adott rendszer, például egy hardver vagy szoftver használatában. Világos és értelmes információkat nyújtanak a felhasználók által gyakran felmerülő kérdésekre. A felhasználói útmutatók tartalmazhatnak információkat a lehetséges meghibásodásokról és azok kijavításának módjairól is. Erre példa a ClickHelp online súgó. Ez leírja ennek a szoftverdokumentációs eszköznek a funkcióit, lehetőségeit és felhasználási eseteit.

Termék kézikönyvek

A termék kézikönyvek azért készülnek, hogy leírják egy termék alapvető műveleteit, főbb jellemzőit, általános karbantartását és így tovább. Íme egy példa – egy oldal egy karóra kézikönyvéből:

API dokumentáció

A műszaki írók API dokumentációt készítenek, amelyben leírják a hardver (SCPI), web-API vagy szoftver API hatékony használatára vonatkozó utasításokat. Általában az API dokumentáció tartalmazza az API-val való munkához szükséges összes információt, az osztályok, függvények, argumentumok és hasonlók részleteit, példákkal és útmutatókkal alátámasztva.

Az API dokumentáció célja, hogy segítse az ügyfeleket vagy a felhasználókat az API megvalósításában és működésének megértésében. Az ilyen típusú dokumentáció segít például a vállalkozásoknak abban, hogy a felhasználók könnyebben tudjanak interakcióba lépni a kóddal.

Az API dokumentációról bővebben ebben a cikkben olvashat:

Tudományos munkák, kutatások és jelentések

A műszaki írók más területek szakembereivel is együtt dolgoznak, például az orvostudomány, a tudomány, az űrkutatás, a mérnöki tudományok stb. területén.

A tudományról és az orvostudományról szólva, a kutatók tanulmányokat írnak munkájuk eredményeiről, de ezeket az eredményeket nehéz lehet elmagyarázni a széles közönségnek, ezért a szerzők a műszaki írókat kérik fel, hogy segítsenek nekik értelmezni és rendszerezni az eredményeket. Ezeket folyóiratokban teszik közzé, és emiatt nagyon fontos a pontosság és a tartalom megszervezése – és erre a munkára a műszaki írók a legalkalmasabbak.

A műszaki írók az üzleti vállalkozások tulajdonosainak is segítenek, hogy elkészíthessék jelentéseiket, mert a tartalom egyértelműsége és pontossága szintén követelmény.

Technikai marketingdokumentáció

A műszaki írók a marketing tartalmakra is kiterjednek: A műszaki írók könnyen értelmezhető és tömör cikkeket tudnak készíteni, amelyek segítenek az ügyfeleknek megérteni, hogyan kell megfelelően működtetni egy terméket. A fehér könyvek, esettanulmányok, javaslatok a műszaki marketingdokumentáció példái.

White Papers

A fehér könyvek fő célja, hogy kiemeljék a vállalat sikereit, és segítsék a vállalat termékeinek vagy szolgáltatásainak népszerűsítését. Marketingeszközként a fehér könyvek összegyűjtik a tényekre vonatkozó információkat és logikus érveket, hogy miért ez a vállalat és annak terméke a legjobb. A fehér könyvek általában egy régi probléma új megoldására vagy egy B2B termék vagy szolgáltatás előnyeire összpontosítanak.

Egy esettanulmány

Az esettanulmány egy vállalat, termék vagy projekt elemzése, amely azonosít egy olyan megoldást vagy helyzetet, amely hozzájárult a kudarchoz vagy a sikerhez. Az esettanulmányok lehetővé teszik a potenciális vásárlók számára, hogy az Ön termékét működés közben lássák. A vásárlói tapasztalatokra összpontosítanak, hogy megmutassák, hogyan segíthet egy adott termék vagy szolgáltatás az Ön és vállalkozása számára.

Javaslatok

A műszaki írók ajánlatokat is készítenek B2B vállalatok számára. A műszaki írók segítenek meggyőzni az olvasót egy javasolt projekt jóváhagyásáról vagy egy javasolt terv megvalósításáról. Tartalmazhat ajánlásokat, felmérések eredményeit, műszaki hátteret, megvalósíthatósági információkat és így tovább.

A műszaki dokumentációnak természetesen más típusai és más osztályozásai is vannak. A ClickHelp blogon például a dokumentáció típusai olvasók, iparágak és más típusok szerint vannak felosztva. Többet megtudhatsz itt: ‘A műszaki dokumentumok típusai’.