Technische Redaktion

Aus InfoWissWiki - Das Wiki der Informationswissenschaft
Wechseln zu: Navigation, Suche

Technische Dokumentation und Redaktion

Die Aufgabe eines technischen Redakteurs ist es, aus einer technischen Dokumentation alle wichtigen Informationen für Nutzer und Hersteller eines Produktes in strukturierter Form aufzubereiten. Er bedient sich dabei verschiedener Software-Systeme, Redaktionssysteme genannt, die seine Arbeit unterstützen.

Erläuterung: Technische Dokumentation meint die Dokumentation von technischen Systemen. Sie kann die Grundlage der Kommunikation zwischen Nutzern und Herstellern sein. Produkte sind nicht zwingend Geräte, also gegenständlich, auch Dienstleistungen sind diesem Begriff untergeordnet.
Zu den o.g. Informationen gehören beispielsweise Produktunterlagen, Bedien-Handbücher, Anleitungen, Service- und Wartungshandbücher aber auch Warnhinweise an Maschinen, Qualitätsmanagementhandbücher oder Online-Hilfen.
Die technische Dokumentation fällt in den Bereich der Produkthaftung.
In der Norm EN-ISO 90xx wird das Vorgehen für das Qualitätsmanagement der Dokumentation von Verfahrensweisen etc. festgehalten.

Probleme in der technischen Redaktion und ihre Lösungen

Die Datenstruktur

Die Datenstruktur stellt z.Zt. einen grundlegenden Schwachpunkt der Arbeit dar. Die meisten Daten werden seitenorientiert strukturiert, die Vorgehensweise ist also die, dass mit Hilfe von HTML für Web oder DTP-Programmen (z.B. Adobe InDesign, QuarkXPress. u.v.m.) für den Printbereich ein Seitenformat definiert wird und darauf dann Texte, Grafiken und Bilder angeordnet werden. Es stehen sich hier also die optische Strukturierung, z.B. durch Textformatierung und Seitenumbrüche und die inhaltliche Strukturierung, wie z.B. durch XML, die ein gezieltes Information Retrieval im Dokument ermöglicht, gegenüber. In diesem Zusammenhang wird auch der Begriff Dokumenten- und Seitenmetapher benutzt. Ersteres steht für die dokumentarische Bezugseinheit, in diesem Fall die Datei, und letzteres für das Präsentationselement, die Seite.

Nachteile der Datenstruktur

Die seitenorientierte Datenstruktur bringt dadurch weitere Nachteile mit sich, dass ihre Anwendungsmöglichkeiten begrenzt sind, was sich durch die Weiterentwicklung von Software ändern kann. Mit anderen Worten ist es heute kaum möglich, ein seitenorientiertes Dokument für unterschiedliche Anwendungsgebiete zu erstellen. Es müssen je nach Verwendungszweck Dokumente unterschiedlicher Qualität und Dateiformatierung generiert werden.

Die Navigation

Ungenauigkeiten können auch beim Navigieren in einem Dokument durch Links auftreten. So kann es passieren, dass nicht das Linkziel selbst angezeigt wird, sondern der obere Rand der Seite, auf der es angelegt ist. Diese Schwierigkeiten treten bei verschiedenen Viewern auf, sind aber auf HTML-Seiten meistens gelöst.

Chancen der Software

DTP-Software bietet eine Vielzahl an Möglichkeiten, Dokumente zu strukturieren und zu formatieren. Unterschiedliche Hersteller bringen verschieden benannte Software für das Desktop-Publishing auf den Markt. Die Programme verfügen aber im Großen und Ganzen über die gleichen Eigenschaften, Komponenten und die Möglichkeit des Datenaustauschs durch Import- und Exportfilter. Der Nachteil liegt in der Benennung und Anordnung dieser Bestandteile. Sollte ein User also einmal ein anderes Programm verwenden, kann er nicht sicher sein, auf Anhieb zu wissen, hinter welchem Menüpunkt sich der gewünschte Befehl befindet. Das führt letztendlich dazu, dass die Möglichkeiten der Programme nicht voll ausgeschöpft werden. Eine zumindest teilweise Normierung der Benennung von Software-Eigenschaften und Befehlen könnte eine Verbesserung forcieren.
Nachteil: Wenn eine technische Dokumentation, die zu einem langlebigen Produkt wie z.B. einer Druckmaschine gehört, als Datei abgespeichert ist, sind der Kunde und der Hersteller dazu gezwungen, die dazugehörige Software in einer Version aufzubewahren, die in der Lage ist, das Format zu lesen.
Dokument-Management-Systeme sind zwar u.a. fähig, Versionen und Varianten zu verwalten und Freigabe und Zugangsberechtigungen zu überwachen, arbeiten jedoch dokumentenbezogen, was keine wirkliche Verbesserung der Arbeitsstruktur des technischen Redakteurs bedeutet.
Im Gegensatz dazu konzentrieren sich die Content-Management-Systeme, wie der Name schon sagt, auf den Inhalt der Dokumente, die eigentliche Information, die ohne zweckgebundene Formatierung abgespeichert wird und nach Bedarf in entsprechende Layouts und Stilvorlagen einfließen kann. Der technische Redakteur wird hier auch als Content-Manager bezeichnet.

Konvertierung

Ein programmeigenes Dateiformat kann die in der Software integrierten Formatierungsmöglichkeiten optimal abspeichern und bleibt als so genannte offene Datei für die spezifische Software bearbeit- bzw. wandelbar. Soll eine solche Datei für eine oder gleich mehrere andere Anwendungen genutzt werden, kommt es zur Datenkonvertierung. D.h. die Formatierung der Datei wird derart umgewandelt, dass andere Programme sie lesen und den Inhalt zumindest darstellen können. Oft kann der Inhalt der Datei dann nur noch umständlich oder gar nicht mehr verändert werden. Es muss also bei der Wahl des Datenaustauschformats darauf geachtet werden, für welche Weiterverwendung, Programme und Veröffentlichung, sprich Bildschirm, Print etc. der Inhalt der Datei gedacht ist.

Konsistenzproblematik

Wenn in einem Dokument an mehreren Stellen auf eine Information zugegriffen wird, Querverweise oder Wiederverwendung existieren, ist bei Änderungen auf Konsistenz zu achten. Sie wird dadurch aufrechterhalten, dass alle betroffenen Stellen inkl. Querverweise und Wiederverwendungen etc. geändert werden. Bei Dokumenten, die seitenorientierte Strukturen aufweisen, kann das zu Verschiebungen und damit zur Verschlechterung des Layouts führen.

Fazit

Um die Arbeitsbedingungen des technischen Redakteurs zu verbessern, sollten die Daten einer technischen Dokumentation über bestimmte Eigenschaften verfügen.

  1. Der Inhalt sollte unabhängig vom Layout sein
  2. Der Text sollte dem Information Retrieval uneingeschränkt zur Verfügung stehen
  3. Die Konsistenzproblematik sollte sich leicht überwachen lassen
  4. Die Datenstruktur sollte die Art der Veröffentlichung nicht einschränken
  5. Die Dokumentation sollte nicht nur von einem bestimmten Programm oder einer Programmversion dargestellt werden können

Lösungsansätze zu den einzelnen Punkten

  1. XML als Untermenge von SGML. Es bietet die Möglichkeit, die Dokumentation inhaltlich zu strukturieren, aber mit Hilfe von XSL auch das Layout zu beeinflussen
  2. Auch hier kann wieder auf XML verwiesen werden, da es inhaltliche Strukturen aufbauen kann und somit das Information Retrieval vereinfacht
  3. Es gibt bereits semiautomatische Verfahren, die Autoren bei der Überwachung der Konsistenz unterstützen. Diese können jedoch nur kodierte Informationen verarbeiten
  4. Single Source Publishing legt zu Grunde, dass eine einzige Datei als Basis existiert, in der alle Änderungen vorgenommen werden. Diese kann dann immer wieder neu für unterschiedliche Verwendungszwecke in Gestaltungsvorlagen einfließen. Hierfür muss allerdings immer auf die Informationen zugegriffen werden können. Sollten Änderungen am Layout notwendig werden, muss nur die Vorlage geändert werden, die Information selbst bleibt davon unbeeinträchtigt, man spricht deshalb von Single Source Information.
  5. XML ist ein ISO-Standard (Homepage der International Organization for Standardization) und somit herstellerunabhängig. Es ersetzt dadurch den Zwang, für die Nutzung einer technischen Dokumentation Programme bzw. Programmversionen bestimmter Hersteller aufzubewahren.


Quelle

  • Panyr, Jiri (2004): Technische Redaktion. In: Kuhlen/Seeger/Strauch (Hrsg.): Grundlagen der praktischen Information und Dokumentation, Kap C9, S. 461-467