Ende 2013 habe ich die Umfrage „Ein Wiki in der technischen Dokumentation – Geht das?“ initiiert. Über 70 Redakteure haben sich beteiligt. Vorwiegend arbeiten die Umfrageteilnehmer in den Bereichen Software, Maschinen-und Anlagenbau sowie Elektrotechnik. Auffällig ist, dass über 84 % von ihnen länger als 3 Jahre im Feld der Technischen Dokumentation tätig sind. Ob dies… [weiterlesen]
Bei der Kommentierung und Analyse von Anleitungen stoße ich immer wieder auf das Phänomen, dass vor dem Inhaltsverzeichnis ein Text steht. Aus meiner Sicht macht dies wenig bis keinen Sinn. Bedenklich wird es, wenn Redakteure vor dem Inhaltsverzeichnis wichtige oder gar sicherheitsrelevante Informationen platzieren. Inhaltsverzeichnis – Sinn und Zweck Das Inhaltsverzeichnis soll dem Leser einen… [weiterlesen]
Über die Qualität von technischer Dokumentation ist schon einiges geschrieben worden, selten wird dabei die Phase vor der Texterstellung betrachtet. Natürlich ist es wichtig, sich Gedanken darüber zu machen, wie Inhalte verständlich vermittelt werden oder auch wie Texte effektiv formuliert werden. Aber keine noch so verständlich geschriebene und gut strukturierte Anleitung hilft, wenn die Inhalte… [weiterlesen]
Modulares Arbeiten basiert auf dem Prinzip der Wiederverwendung, so dass ein Modul in verschiedenen Dokumenten oder in einer Anleitung an mehreren Stellen eingesetzt wird. Eine Hürde beim modularen Arbeiten bildet häufig das Wissen oder leider Nicht-Wissen, in welchen Dokumenten welches Modul verwendet wird. Wer in einer XML-Umgebung arbeitet, kann mit dem Plug-In InsetPlus eine gewisse… [weiterlesen]
Immer wieder begegnen wir Varianten in der technischen Dokumentation und immer möchten und müssen wir ihnen Herr werden. In meinem ersten Beitrag zum Themengebiet „Varianten in der technischen Dokumentation“ habe ich den Einsatz von Variablen diskutiert. Diese sind geeignet, kleinere Unterschiede zwischen Dokumenten zu steuern. In der technischen Dokumentation differenzieren Texte häufig nicht nur durch… [weiterlesen]