Technické psaní je víc než jen psaní návodů k použití nebo opravě televizoru. Zahrnuje různé typy dokumentů, dokonce i marketingové. Přečtěte si tento článek a dozvíte se více o technické dokumentaci; bude užitečný pro začínající autory technické dokumentace, kteří se chtějí rozhodnout, jaký typ dokumentace je bude zajímat.

Uživatelské příručky, manuály, návody „Jak na to“ a podobně jsou nejběžnějšími typy technické dokumentace a jsou to ty, které se lidem vždy vybaví, když někdo řekne „technická dokumentace“. Dovolte mi, abych některé typy podrobně popsal.

Uživatelské příručky

Uživatelské příručky pomáhají lidem používat určitý systém, například hardware nebo software. Poskytují jasné a rozumné informace o běžných otázkách, se kterými se uživatelé mohou setkat. Uživatelské příručky mohou také obsahovat informace o možných poruchách a způsobech jejich odstranění. Příkladem je online nápověda pro ClickHelp. Popisuje funkce, možnosti a případy použití tohoto softwarového dokumentačního nástroje.

Příručky k produktům

Příručky k produktům jsou vytvářeny s cílem popsat základní operace produktu, jeho hlavní funkce, obecnou údržbu a další. Zde je příklad – stránka z příručky k náramkovým hodinkám:

Dokumentace API

Techničtí autoři vytvářejí dokumentaci API, kde popisují pokyny, jak efektivně používat hardwarové (SCPI), webové API nebo softwarové API. Dokumentace API obvykle obsahuje všechny informace potřebné pro práci s rozhraním API, podrobnosti o třídách, funkcích, argumentech a podobně, podpořené příklady a návody.

Dokumentace API má za cíl pomoci klientům nebo uživatelům implementovat rozhraní API a pochopit, jak funguje. Tento typ dokumentace pomáhá například firmám usnadnit uživatelům práci s kódem.

Chcete-li se o dokumentaci API dozvědět více, přečtěte si tento článek:

Vědecké práce, výzkumy a zprávy

Techničtí spisovatelé spolupracují také s odborníky z jiných oblastí, jako je medicína, věda, letectví, strojírenství a podobně.

Když už mluvíme o vědě a medicíně, vědci píší dokumenty s výsledky své práce, ale tyto výsledky může být obtížné vysvětlit širokému publiku, proto autoři žádají technické spisovatele, aby jim pomohli interpretovat a uspořádat výsledky. Ty jsou publikovány v časopisech, a proto je velmi důležitá přesnost a uspořádání obsahu – a techničtí spisovatelé jsou pro tuto práci nejlepší.

Techničtí spisovatelé také pomáhají majitelům firem, aby jim pomohli vytvořit zprávy, protože je také vyžadována jasnost a přesnost obsahu.

Technická marketingová dokumentace

Technické psaní zahrnuje také marketingový obsah. techničtí spisovatelé mohou vytvářet snadno interpretovatelné a stručné články, které pomáhají klientům pochopit, jak správně používat produkt. Příkladem technické marketingové dokumentace jsou bílé knihy, případové studie, návrhy.

Bílé knihy

Hlavním cílem bílé knihy je vyzdvihnout úspěch společnosti a pomoci propagovat výrobky nebo služby společnosti. Jako marketingový nástroj shromažďují bílé knihy informace o faktech a logické argumenty, proč je tato společnost a její produkt nejlepší. Bílé knihy se obvykle zaměřují na nová řešení starého problému nebo na výhody produktu či služby B2B.

Případová studie

Případová studie je analýza společnosti, produktu nebo projektu, která identifikuje řešení nebo situaci, která přispěla k neúspěchu nebo úspěchu. Případové studie umožňují potenciálním kupujícím vidět váš produkt v akci. Zaměřují se na zkušenosti zákazníka, aby ukázaly, jak může konkrétní produkt nebo služba pomoci vám a vaší firmě.

Propozice

Techničtí autoři vytvářejí také nabídky pro společnosti B2B. Techničtí spisovatelé pomáhají přesvědčit čtenáře, aby schválili navrhovaný projekt nebo realizovali navrhovaný plán. Může obsahovat doporučení, výsledky průzkumů, technické podklady, informace o proveditelnosti a podobně.

Samozřejmě existují i další typy a další klasifikace technické dokumentace. Například na blogu ClickHelp jsou typy dokumentace rozděleny podle čtenářů, odvětví a dalších. Více informací se můžete dozvědět zde:

: „Typy technické dokumentace“.