Qualität beginnt mit der Recherche

Ü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]

Modularisierung mit Übersicht

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]

Produktrückrufportal als App

Produktrückrufe gibt es quasi täglich. 2012 haben insgesamt 2.278 Mal die Mitgliedstaaten Maßnahmen im Zusammenhang mit gefährlichen Produkten (außer Lebensmitteln) ergriffen und über RAPEX gemeldet. Dies bedeutet, die Anzahl der Warnmeldungen stieg im Vergleich zum Vorjahr um 26 %. Die am häufigsten im Zusammenhang mit diesen Produkten gemeldeten Risiken waren chemische, Erdrosselungs- und Verletzungsrisiken (siehe… [weiterlesen]

Varianten in der technischen Dokumentation (3) – Plug-In im strukturierten FrameMaker

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]

Gastbeitrag von Marc Achtelig: Dynamische Hilfe

In seinem Gastbeitrag wägt Marc Achtelig die Vorteile und Nachteile von Dynamischen Hilfen ab. In den meisten Fällen ist seiner Meinung nach der Einsatz von Dynamischen Hilfen sinnvoll. Dies demonstriert er anhand von einigen Beispielen. Ich freue mich, mit dem Beitrag von Marc Achtelig den zweiten Gastbeitrag begrüßen zu dürfen. Marc Achtelig beschreibt seit mehr… [weiterlesen]