Nejlepší odpověď
Existuje tolik různých typů technické dokumentace, že je téměř nemožné zde všechny vyjmenovat.
Během své dlouhé kariéry jako technický spisovatel jsem osobně musel napsat více než 15 různých typů technických dokumentů, které se u jednotlivých projektů liší.
Na nejabstrahovanější úrovni mohou technické dokumenty být rozděleny do kategorií zapsaných pro interní uživatele a externí koncové uživatele .
Například Průvodce konfigurací systému je příkladem „interního“ dokumentu, zatímco Instalační příručka je příkladem dokumentu „externího koncového uživatele“.
Průvodce API může být pro interní použití oba a externí uživatelé. Stručný průvodce je naproti tomu téměř vždy určen pro externí koncové uživatele.
Napsal jsem Uživatelské příručky , Průvodce řešením problémů , Referenční listy , Poznámky k verzi , (upravené) Dokumenty k marketingovým požadavkům (MRD), Dokumenty o architektuře a inženýrství (A&E Doc), Soubory nápovědy , Příručky o standardním provozním postupu (SOP) a další.
Můžete navštívit Centrum technické komunikace pro více a bezplatné informace o všech těchto různých typech technických dokumentů.
Odpověď
Existují různé způsoby kategorizace existujících typů technické dokumentace. Nepředstírám, že je všechny znám, ale dvě hlavní široké kategorie, které můžete použít ke kategorizaci jakékoli technické dokumentace, jsou uživatel a případ použití.
Pod „uživatelem“ myslím co typ uživatele, který bude dokument používat? Je to příručka pro správce, nebo návod, nebo uživatelská příručka? Tyto úrovně znalostí se berou v úvahu při navrhování dokumentu. Příručka pro správce předpokládá, že osoba, která dokument čte, ví o něco více než čtenář tutoriálu.
Výrazem „případ použití“ myslím to, k čemu se dokument používá? To může sahat od vojenské dokumentace o tom, jak spustit raketu až po dokumentaci pro vývojáře, jak používat grafické API k vývoji videohry.
Pokud můžete zúžit svoji otázku, možná budu schopen abychom vám poskytli více z toho, co hledáte.