Wissen über technische Dokumentation

E-Book: Grundlagen der technischen Dokumentation

Auf dieser Seiten finden Sie Fachartikel über die Grundlagen der modernen technischen Dokumentation. Teilweise handelt es sich um Auszüge aus dem E-Book "Grundlagen der technischen Dokumentation - Motivationen, Methoden und Zusammenhänge". Das E-Book kann kostenfrei als PDF hier heruntergeladen werden.

Was ist technische Dokumentation?

Technische Dokumentation beinhaltet alle Informationen, die von einem Hersteller/Vertreiber parallel zum Entstehen und zum Lebensweg eines Produktes (Produktlebenszyklus) erstellt werden.

Gesetzliche Grundlagen der technischen Dokumentation

Die Notwendigkeit technischer Dokumentation ist gesetzlich verankert. Mehrere Gesetze verlangen, dass Hersteller ihren Produkten Informationen beilegen, die die Nutzer dazu befähigen, ein Produkt gefahrlos zu verwenden.

Anforderungen an technische Dokumentation aus Nutzersicht

Der Aspekt der leichten Verständlichkeit ist sehr umfangreich. Es gibt eine Vielzahl von Aspekten, die Einfluss darauf haben, was von einer Zielgruppe gut verstanden werden kann.

Inhalt von technischer Dokumentation

Bei der Frage, welche Inhalte oder Themen technische Dokumentation enthalten soll, sind je nach Branche und Produkttyp eine Reihe von Vorschriften und Normen zu berücksichtigen.

Technische Dokumentation leicht verständlich und effizient

Ein Informationsprodukt ist leicht verständlich, wenn sein Inhalt von einer bestimmten Zielgruppe ohne größere Anstrengung korrekt verstanden wird. Wie das erreicht werden kann, dafür gibt es eine Reihe von Methoden.

Redaktionssysteme/CMS für die technische Dokumentation

Ein Redaktionssystem bzw. CMS ist eine Software, mit der Inhalte erstellt und verwaltet werden können. Ob man "Content-Management-System" oder "Redaktionssystem" sagt, ist eine Geschmacksfrage.

Linksammlung

Interessante Links rund um die technische Dokumentation