Artikel aus 2013

Sichtbarkeitslinien der technischen Redaktion

Publiziert am von Britta Görs

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]

Buchbesprechung: Dokumentation in agilen Projekten

Publiziert am von Britta Görs

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]

Qualität beginnt mit der Recherche

Publiziert am von Britta Görs

Ü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

Publiziert am von Britta Görs

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

Publiziert am von Britta Görs

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]