Beste Antwort
Es gibt so viele verschiedene Arten von technischen Dokumenten, dass es fast unmöglich ist, alle hier aufzulisten.
Während meiner langen Karriere als technischer Redakteur muss ich persönlich über 15 verschiedene Arten von technischen Dokumenten geschrieben haben, die von Projekt zu Projekt unterschiedlich sind.
Auf der abstraktesten Ebene können technische Dokumente in diejenigen eingeteilt werden, die für die internen Benutzer und externe Endbenutzer geschrieben wurden.
Beispielsweise ist ein Systemkonfigurationshandbuch ein Beispiel für ein „internes“ Dokument, während ein Das Installationshandbuch ist ein Beispiel für ein „externes Endbenutzer“ -Dokument.
Ein API-Handbuch kann beides für intern sein und externe Benutzer. Eine Kurzanleitung ist dagegen fast immer für externe Endbenutzer gedacht.
Ich habe Benutzerhandbücher , Fehlerbehebungshandbücher , Referenzblätter , Versionshinweise , (bearbeitet) Marketinganforderungsdokumente (MRD), Architektur- und Konstruktionsdokumente (A & E Doc), Hilfedateien , SOP-Handbücher (Standard Operation Procedure ) und mehr.
Sie sind herzlich eingeladen, das Technical Communication Center Weitere und kostenlose Informationen zu all diesen verschiedenen Arten von technischen Dokumenten.
Antwort
Es gibt verschiedene Möglichkeiten, die Arten der vorhandenen technischen Dokumentation zu kategorisieren. Ich gebe nicht vor, alle zu kennen, aber die beiden Hauptkategorien, anhand derer Sie technische Dokumentationen kategorisieren können, sind der Benutzer und der Anwendungsfall.
Mit „dem Benutzer“ meine ich was Art des Benutzers wird das Dokument verwenden? Ist es ein Administratorhandbuch oder ein Tutorial oder ein Benutzerhandbuch? Diese Wissensniveaus werden bei der Gestaltung eines Dokuments berücksichtigt. In einem Administratorhandbuch wird davon ausgegangen, dass die Person, die das Dokument liest, etwas mehr weiß als der Leser des Lernprogramms.
Mit „Anwendungsfall“ meine ich, wofür wird das Dokument verwendet? Dies kann von militärischer Dokumentation zum Starten einer Rakete bis hin zur Entwicklerdokumentation zum Verwenden einer Grafik-API zum Entwickeln eines Videospiels reichen.
Wenn Sie Ihre Frage eingrenzen können, kann ich dies möglicherweise um Ihnen mehr von dem zu geben, wonach Sie suchen.