|
Aktuelle Artikel und Nachrichten rund um die technische Dokumentation finden Sie im Nachfolgemagazin der doculine news, den transline tecNews
Redaktionsleitfäden
– Ein unersetzliches Hilfsmittel in der Technikredaktion
Artikel
erschienen in
Ausgabe April 1998
Von
Rolf Schwermer
Inhaltsübersicht:
Ein
sorgfältig erarbeiteter Redaktionsleitfaden ist ein unersetzliches
Hilfsmittel für jede Technikredaktion. Denn nur so lassen
sich die qualitativen Anforderungen, denen technische Dokumentation
genügen muß, hauseinheitlich und mit minimalem Aufwand
bewältigen.
Dennoch
sind in der Praxis nur wenige veröffentlichte Redaktionsleitfäden
bekannt. Worin liegt dies begründet? Wie gelangt man zu einem
Redaktionsleitfaden? Und wie sind die zu erwartenden Hindernisse
zu überwinden?
Qualitätsanforderungen an technische Dokumentation
Technische
Dokumentationen müssen bestimmten Qualitätsanforderungen
genügen – sowohl aus Sicht der Nutzer als auch aus Sicht
der Hersteller:
|
|
Verfügbarkeit:
Technische Dokumentation soll zur richtigen Zeit zu angemessenen
Kosten bereitgestellt werden. Technische Redakteure müssen
deswegen den gesamten Erstellungsprozeß planen.
|
|
|
Eignung:
Technische Dokumentation soll mit den Zielen und Zwecken,
für die sie gedacht ist, übereinstimmen. Technische
Redakteure müssen daher die Ziele und Zwecke vor der
eigentlichen Erstellung analysieren und z.B. die Adressaten,
für die die technische Dokumentation gedacht ist, bestimmen
(Zielgruppenanalyse).
|
|
|
Dokumentzugänglichkeit:
Technische Dokumentation soll für die Anwender
lesefreudlich organisiert sein, so daß sie schnell
die Informationen finden, die sie aktuell benötigen.
|
|
|
Lesbarkeit/Verständlichkeit:
Technische Dokumentation soll für die jeweiligen Adressaten
flüssig und einfach zu lesen und leicht verständlich
sein.'
|
|
|
Vollständigkeit:
Bei den meisten Dokumentationen vom Typ Nachschlageanleitung
muß die Vollständigkeit der Informationen gewährleistet
sein, bei Kurz- und Lernanleitungen hingegen nicht.
|
|
|
Richtigkeit
sollte eigentlich eine Selbstverständlichkeit in allen
Dokumentationsformen sein.
|
|
|
Sicherheit
der Anwender bei der Nutzung eines Produktes ist oberstes
Ziel der einschlägigen gesetzlichen und normativen
Bestimmungen zur technischen Dokumentation. Sicherheitshinweise
und Warnungen sind ein wichtiger Beitrag dazu.
|
Damit
diese Qualitätsanforderungen erfüllt werden können,
sind in einer technischen Redaktion Entscheidungen zu treffen,
die einerseits abgesichert sein müssen, andererseits über
den tagesaktuellen Dokumentationsfall hinaus Gültigkeit haben
sollten. Um die einmal getroffenen Entscheidungen festzuhalten,
ist ein Redaktionsleitfaden das geeignete Instrument.
Und
vor allem ist mit einem sorgfältig geführten Redaktionsleitfaden
besser zu gewährleisten, daß alle am Erstellungsprozeß
Beteiligten – interne wie externe Mitarbeiter – eine
einheitliche Linie in der Dokumentation einhalten.
Was ist ein Redaktionsleitfaden?
Im allgemeinen
versteht man in einer Technikredaktion unter einem Redaktionsleitfaden
eine Art "Anleitung zum Verfassen von Anleitungen",
also eine umfassende Sammlung all der Vorgaben, Festlegungen und
Entscheidungen, die notwendig sind, um qualitativ gute technische
Dokumentation zu erstellen.
Für
Redaktionsleitfäden gibt es viele, häufig synonyme Bezeichnungen:
- Redaktionshandbücher
- Style
Guides
- Dokumentationsrichtlinien
- Corporate
Design-Handbücher usw.
Fast jedes
Unternehmen verwendet eine eigene Bezeichnung – und versteht
auch unterschiedliche Aspekte darunter.
Zweck eines Redaktionsleitfadens
Unabhängig
davon, welche Bezeichnung gewählt wird und welches Verständnis
dahintersteht, sollte man sich zunächst fragen, welchen Zweck
der zu erstellende Redaktionsleitfaden erfüllen soll. Ein
Redaktionsleitfaden kann nämlich u.a.dazu dienen,
- die gesamte
Arbeit in einer technischen Redaktion systematisch aufzubauen
- Qualitätsmaßstäbe
für die Arbeitsergebnisse der technischen Redaktion transparent
zu machen
- alle Vorgaben,
Ziele und Abläufe zu klären und nachvollziehbar zu
machen
- die Mitarbeiter
in der technischen Redaktion bei ihrer täglichen Arbeit
zu unterstützen und zu motivieren
- neuen
Mitarbeitern die Einarbeitung zu erleichtern
Damit ist
ein Redaktionsleitfaden ein erster, wichtiger Schritt hinzur Einführung
eines Qualitätsmanagement-Systems für eine Technikredaktion!
Inhalte eines
Redaktionsleitfadens
Ein Redaktionsleitfaden
kann beispielsweise Festlegungen zu den folgenden Bereichen der
Dokumentations-Erstellung enthalten:
- zur Sprache
(Wortwahl/Terminologielisten, Textaufbau)
- zu Inhalten
(z.B. standardisierte Inhalte)
- zum Aufbau/zur
Gliederung (z.B. modulartiger Aufbau von Teilen der technischen
Dokumentation)
- zur Gestaltung
(Typografie, Layout, äußere Gestaltung)
- zu technischen
Arbeitsmitteln der Dokumentations-Erstellung
- zu allen
Prozessen der Dokumentations-Erstellung (Planung, Informationsbeschaffung,
Erstellung, Korrektur, Freigabe, Qualitätssicherung/Usability
Testing, Produktion, Distribution, Wartung/Revision, Archivierung)
- zu Verantwortlichkeiten
in den jeweiligen Prozessen
- zu Fragen
der Kostenplanung/Finanzierung
Ein Redaktionsleitfaden
kann also zu allen diesen Bereichen Aussagen enthalten –
oder aber nur zu einigen der genannten, z.B. nur zu Gestaltungsfragen(dann
ist er ein Style Guide im engeren Wortsinne).
Vier
Beispiele für Redaktionsleitfäden
Die
Vielfalt der Ansätze sollen einige Beispiele von Redaktionsleitfäden
aus verschiedenen Branchen und mit unterschiedlichen Zielsetzungen
verdeutlichen. Vorgestellt werden jeweils markante Ausschnitte
aus der Gliederung.
"DesignManual" von Tanner
Dokuments
Der
Dokumentationsdienstleister Tanner Dokuments hat in Heft 6/1991seines
Newsletters ABZ die inhaltliche Struktur eines "DesignManual"
vorgestellt, das in etwa einem Redaktionsleitfaden entspricht:
- Allgemeine
Hinweise
Benennung und Organisation von Dokumenten
Hinweise zur Arbeit mit verwendeter Software
Schriften für spezielle Einsatzzwecke
- Erstellungshilfen
für bestimmte Produktlinien
Masterseiten
Definition der Druckformate
Anwendung der Druckformate
Inhalt der Masterdisketten
- Musterseiten
(Beispielseiten für Titelseiten, Inhaltsverzeichnisse,
...)
- Abschließende
Bearbeitung
Checklisten für die Endkontrolle, Verwaltung,
Ausrüstmustererstellung
Angaben für Drucker/Endverarbeiter
|
Technische
Dokumentation wurde 1991 in erster Linie als gedrucktes Medium
produziert. Der als "DesignManual" bezeichnete Redaktionsleitfaden
machte dementsprechend hauptsächlich Aussagen zur Gestaltung,
dem "Design" der Dokumente, sowie zum Umgang mit dem
zum damaligen Zeitpunkt noch jungen Arbeitsmittel Desktop Publishing-Software.
Inhaltliche und strukturelle Fragen wurden jedoch kaum angesprochen.
"Standpunkte
zu Anleitungen, deren Gestaltung und Erstellung" der Robert
Bosch GmbH
Bereits
etwa 1985 konzernintern veröffentlicht, sind die "Standpunkte
zu Anleitungen" der Robert Bosch GmbH und die damit verbundene
Zielsetzung noch immer sehr aktuell: "Diese Broschüre
(...) zeigt, welchen Stellenwert den Anleitungen beigemesen wird
und welche Punkte beim Erstellen von Anleitungen zu beachten sind.
In Ergänzung zu Schulungen dient die Broschüre als Gedächtnisstütze.
(...) Die Standpunkte sollen den Autoren helfen, die Anleitungen
so zu gestalten, daß sie dem Anwender einen optimalen Produktnutzen
ermöglichen."
- Vorwort
- Sind
Anleitungen mehr als ein notwendiges Übel?
- Was
muß eine Anleitung leisten, um gut zu sein?
- Wie
kann man übersichtliche, bedarfsgerechte und verständliche
Anleitungen erstellen?
- Warum
ist es erforderlich, das Informationsangebot vor dem Erstellen
einer Anleitung festzulegen?
- Wie
kann man die Information einer Anleitung lernlogisch gliedern?
- Welche
Punkte sind beim Gestalten einer Anleitung zu beachten?
- Welches
Format, welche Text-/Bildzuordnung und Schrift sind festzulegen?
- Welches
Ordnungssystem und welche Farben müssen eingesetzt
werden?
- Wann
werden Tabellen, Symbole und Piktogramme verwendet?
- Was
ist bei mehrsprachigen Anleitungen zu beachten?
- Welche
weiteren Gestaltungsmöglichkeiten von mehrsprachigen
Anleitungen gibt es?
- Soll
jede Anleitung mit Bildern versehen werden?
- Wie
läßt sich die Anleitung verständlich formulieren?
- Warum
soll eine Anleitung getestet werden?
- Beispiele
von Anleitungen
- Welche
Gründe sprechen für einen Test der Anleitung
(Checklisten)?
|
"Redaktionsleitfaden
der Technischen Information für die Erstellung von Reparaturleitfäden"
der Volkswagen AG
"Reparaturleitfäden"
werden die Wartungs- und Reparaturanleitungen genannt, die die
Kfz-Mechaniker in VW-Vertragswerkstätten benutzen. Der Redaktionsleitfaden
der Volkswagen AG ist für jene technischen Redakteure gedacht,
die diese Werkstattliteratur erstellen.
| 1.
Vorwort
2.
Welche Informationsmittel mit welchen Strukturen gibt es?
2.1 Reparaturleitfaden
2.2 Instandhaltung genau genommen (Heft)
2.3 Ordner Abgasuntersuchung
2.4 Ordner Stromlaufpläne, ...
3.
Dokumentationsplanung
3.1 Theoretische Grundlagen
3.2 Wandel in Planung und Kommunikation
3.3 Analyse der Zielgruppen (Mechaniker)
3.4 Ermittlung des Informationsbedarfes der Zielgruppen
4.
Technische Arbeitsmittel, Dokument- und Bildverwaltung
5.
Texterstellung
6.
Bilderstellung
7.
Qualitätssicherung
8.
Wirtschaftlichkeit
9.
Pflege des Redaktionsleitfadens
|
Dieses
Dokument ist wahrscheinlich das "klassische" Beispiel
eines Redaktionsleitfadens.
"Style Guide
for online hypertext" von Tim Berners Lee
Tim
Berners Lee, Physiker am europäischen Forschungszentrum für
Teilchenphysik CERN in Genf, ist einer der Väter des World
Wide Web. Bereits 1992, als das WWW noch in den Kinderschuhen
steckte, hat er begonnen, einen "Style
Guide for online hypertext" zusammenzustellen –
mit dem Ziel "to help you create a WWW hypertext database
that effictively communicates your knowledge to the reader."
Seinen
Style Guide hat Tim Berners Lee über das WWW allgemein verfügbar
gemacht, so daß viele Leser mit Kritik, Änderungs-
und Erweiterungswünschen an ihn herantreten konnten. Diese
Anregungen haben Tim Berners Lee zu Überarbeitungen und "Neuauflagen"
seines Style Guide veranlaßt. Die folgende Gliederungsstruktur
gibt den Stand von Mai 1995 wieder:
- Etiquette
for a server administrator
- Overall
structure of a work
Structure for the reader
Trees
Document size
To refer or to copy
- Within
each document
Sign it!
Give its status
Give links into context
A good title
Don’t format for a particular browser
Keep it readable
Don’t mention the mechanics
- Ramblings:
Related but more random thoughts. Under construction
Acceptable Content
Educational hypertext and the "why" link
Why one should provide why links
|
Dies
ist der einzige Leitfaden in dieser Reihe von Beispielen, der
für elektronische Publikationsformen gedacht ist. Allerdings
handelt es sich nicht um einen Redaktionsleitfaden im engeren
Sinne, da er sich nicht an Redakteure, sondern an ein sehr breites
Publikum richtet: an alle, die in irgendeiner Weise etwas im WWW
veröffentlichen.
Der
Anleitungscharakter des Style Guides wird deutlich in den imperativen
Formulierungen: "Give links into context." Dieser anleitende
Charakter macht das Dokument zu einer brauchbaren Vorlage für
Publikationen im WWW oder in anderen elektronischen Medien.
Warum
sind so wenige Redaktionsleitfäden bekannt?
Nur wenige
veröffentlichte Redaktionsleitfäden sind bekannt. Mehrere
Gründe für diesen Mangel oder zumindest geringen Bekanntheitsgrad
vorhandener Redaktionsleitfäden sind zu nennen:
- Redaktionsleitfäden
werden zumeist sehr spezifisch für einzelne Unternehmen
(am ehesten innerhalb von Großunternehmen und Konzernen)
erstellt und bleiben dann als firmeninterne Richtlinie unter
Verschluß; Externe erhalten keinen Einblick.
- In der
Hektik des Redaktionsalltags fehlt häufig die Einsicht,
daß ein Redaktionsleitfaden eine wichtige Hilfe sein könnte,
die wirtschaftliche Lage des Unternehmens verhindert eine Investion
in die Erstellung eines Redaktionsleitfadens, oder man findet
keinen konzeptionellen Ansatz, um einen Redaktionsleitfaden
zu erstellen.
- Der erstellte
Redaktionsleitfaden ist zu komplex, in der Praxis nicht zu handhaben
und wird deswegen abgelehnt.
- Ein vorhandener
Redaktionsleitfaden ist nicht kooperativ in einer Redaktion
entwickelt worden, sondern ist als das Werk eines einzelnen
entstanden – und daher wird er nicht akzeptiert, sondern
ignoriert und mit der Zeit vergessen.
In drei
Schritten zum Redaktionsleitfaden
Einen
Redaktionsleitfaden kann man nicht über Nacht erstellen;
dies erfordert vielmehr recht umfangreiche Vorarbeiten. Da ein
Redaktionsleitfaden als Arbeitsgrundlage für alle Mitarbeiter
einer technischen Redaktion dienen soll und als gemeinsame Grundlage
akzeptiert werden muß, sollten von vornherein alle an seiner
Erstellung beteiligt werden. Falls das nicht machbar ist, sollte
man zumindest alle Beteiligten über die Absichten, Schritte
und Zwischenergbnisse informieren.
Ein
Redaktionsleitfaden sollte über mehrere Zwischenschritte
erarbeitet werden:
|
1.
Schritt:
Eine Dokumentspezifikation (Pflichtenheft) aufstellen
und nach dieser Spezifikation eine Musterdokumentation erarbeiten
– gegebenenhalls für jede Medienform eine separate,
um die unterschiedlichen Medienanforderungen beispielhaft
darzulegen.
2.
Schritt:
Ein umfassendes Konzept für Dokumentationen einer
Klasse (z.B. für eine Gerätegruppe oder Produktlinie)
erarbeiten und nach diesem Konzept einige Dokumente erstellen.
Anschließend sollten diese Dokumente unbedingt evaluiert
werden, z.B. mit einem Usability Test oder zumindest mit
einem Expertengutachten. Die Evaluation ist dringend nötig,
um Verbesserungsmöglichkeiten zu ermitteln, bevor Unzulänglichkeiten
oder Fehler als Quasi-Standard im Redaktionsleitfaden festgeschrieben
werden.
3.
Schritt:
Den Redaktionsleitfaden vor dem Hintergrund der mit
dem Konzept gemachten Erfahrungen erstellen. Dabei sollte
der Redaktionsleitfaden möglichst von Anfang an kooperativ
unter Einbeziehung aller Redaktionsmitarbeiter z.B. in einem
Qualitätszirkel erarbeitet werden und bereits in seinen
Entwicklungsstadien allen Redaktionsmitarbeitern vertraut
sein.
|
Fazit
Wird
ein Redaktionsleitfaden auf diese Art und Weise in einer technischen
Redaktion kooperativ erarbeitet, so kann dies ein sehr spannender
Teambildungsprozeß sein: Alle Redaktionsmitarbeiter setzen
die Organisationsentwicklung ihrer Abteilung gemeinsam in Gang
und sind aktiv daran beteiligt.
|
