Immer wieder beklagen sich Redakteure über zu viel Arbeit. Wenn ich sie dann frage, ob sie nicht von anderen Personen (Kollegen, Dienstleister o.ä.) entlastet werden können, bekomme ich häufig Antworten wie „Meine Aufgaben kann mir keiner abnehmen“ oder “Bis ich das alles jemanden erklärt habe, habe ich es schon selbst gemacht.” Aufgaben zu delegieren, ist… [weiterlesen]
Technische Dokumentation ist immer eine Dienstleistung. Dabei arbeiten technische Redakteure nicht allein, sondern sind auf die Unterstützung von anderen Personen (Entwickler, Konstrukteure, Auftraggebern, Netzwerkpartner etc.) oder Organisationen angewiesen. Einer ist vom guten Service des anderen abhängig. Nicht unerheblich für das Funktionieren jeder Servicekette ist aus meiner Sicht, dass alle Beteiligten eine Vorstellung davon haben, was… [weiterlesen]
Andreas Rüping stellt in seinem Buch Lösungsmuster für gute Dokumentation in Softwareprojekten vor. Der Aufbau des Buches orientiert sich weitgehend am iterativen Vorgehen in agilen Projekten und spiegelt den Lebenszyklus von Dokumenten in einem agilen Kontext wieder. Das Buch richtet sich vor allem an Software-Entwickler und –Architekten. Aber auch für technische Redakteure kann sich das… [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]