Tips & Tricks

Hier veröffentlichen wir in loser Folge Tips, wie Sie Ihre Technische Dokumentation besser (also effektiver) gestalten können.

 

Formulieren Sie kurz!

Die Verständlichkeit eines Satzes nimmt stark ab, wenn er mehr als 12 Worte enthält. Teilen Sie einen Gedanken besser in mehrere Sätze auf.

Schreiben Sie also nicht: Ziehen Sie Nippel (A), nachdem Sie für einen sicheren Stand gesorgt haben, durch Lasche (B), um anschließend Bolzen (C) einzuschlagen.
   
Sondern besser: Der folgende Arbeitsgang erfordert Krafteinsatz. Sorgen Sie deshalb für einen sicheren Stand.
Ziehen Sie Nippel (A) durch Lasche (B).
Schlagen Sie nun den Bolzen (C) ein, um die Verbindung zu sichern.

 

Recherche

"Suchverständige" titelte die c't in ihrer Ausgabe 26/2004 vom 13.12.2004 einen Artikel über Suchmaschinen, Linksammlungen und Webportale. Es fällt nicht nur uns auf, daß das Finden von Informationen für Viele in unserem Mediendschungel ein Problem ist. Daher haben wir hier ein paar Ideen für Recherchen im und außerhalb des Web zusammengestellt, die Sie mit dem Acrobat Reader lesen können.

 

Neue deutsche Rechtschreibung

Rechtschreibung ist eines der wichtigen Themen in der Technischen Dokumentation, wird aber auch gerne vernachlässigt. Ein paar grundsätzliche Gedanken und eine kurze Übersicht zur neuen Rechtschreibung finden Sie hier. Sie benötigen hierfür den Acrobat Reader.

 

Direkte Ansprache des Lesers