Home Previous Zeitschrift 2002/07 Next Index
 
  Inhalt:
 
 
 
Ordnungselemente
   
Verständniselemente
   
Spezielle Inhalte
   
Autor 
   

 

Umrandung für Technische Dokumentation

Neben dem eigentlichen Inhalt kommt der "Umrandung" eine besondere Bedeutung zu. Diese Elemente und Informationen stellen einen großen Teil des Erstellungsaufwandes dar. Sie lassen sich - wie hier gezeigt - sehr stark strukturieren und können dadurch besonders zum einfacheren und zur effektiveren Erstellung beitragen.

Struktur von Technischer Dokumentation

Technische Dokumentation transportiert Informationen meist über ein spezielles Gerät zweckgerichtet an eine spezielle Zielgruppe.

Das folgende Bild zeigt eine Struktur, wie sie für viele Anleitungen verwendet werden kann.

Struktur-in lesbarer Größe

Dabei kann die eigentliche Information meistens in drei einfachen Kategorien geschrieben werden: 

Die Leistungsbeschreibung 
führt ins Gerät ein und umschreibt dem neuen Anwender vor allem den Nutzen, den er aus der Anwendung ziehen kann. 

Die Gerätebeschreibung 
zeigt ihm das Äußere und beschreibt die Bedienelemente. 

Die Tätigkeitsbeschreibung 
leitet den Benutzer an, die einzelnen Tätigkeiten auszuführen.

In speziellen Fällen kommen noch die Inhalte Funktionsweise und Technische Unterlagen hinzu.

Umrandung
Drumherum gibt es aber noch eine Menge an Informationen, die dem Benutzer helfen sich zurechtzufinden, Inhalte zu verstehen und viele Inhalte, die traditionell auf die gleiche Art und Weise dargestellt werden.


  Die hier gezeigten Texte, Bilder und Strukturen sind Auszüge aus dem Buch:

Juhl, Dietrich:
Technische Dokumentation 
– Praktische Anleitungen und Beispiele, 
Springer-Verlag, Heidelberg, 
2002.


Ordnungselemente

In Büchern gibt es traditionell diverse Ordnungselemente, die dem Leser helfen, die vom Autor gewählte Ordnung zu verstehen, bestimmte Inhalte zu finden, oder sich innerhalb des Buches zu orientieren.

Solche Ordnungselemente werden in der Technischen Dokumentation genauso verwendet. Häufig sind sie hier besonders wichtig, weil die Anleitungen sehr umfangreich sind und der Leser vielfach nur ganz gezielt auf bestimmte Inhalte zugreifen will.

Im Folgenden werden diese Elemente einzeln erläutert. 
Bei einigen Elemente ist hier die Struktur dargestellt, die eine Erstellung bedeutend vereinfacht. 



Titelblatt
 
Das Titelblatt ist die sichtbare Vorderseite der Anleitung.

Zweck

Das Titelblatt dient dem Benutzer für folgende Zwecke:
  • Schnelles Finden der richtigen Anleitung 
  • Identifikation (Die Anleitung passt zum Gerät)

Ausführung

Das Titelblatt besteht meistens aus folgenden Elementen:

Struktur: Titelblatt

 
Beispiele, Hinweise
Titel 
Bedienungsanleitung
genaue Gerätebezeichnung 
SP660, SP661
ggf. Sprache der Anleitung 
Deutsch
Abbildung des Gerätes, als Foto oder Zeichnung
Firma als Schriftzug oder Logo 
Siemens
ggf. Zielgruppe der Anleitung 
Anwender
ggf. Ziel der Anleitung 
Inbetriebnahme, Benutzung, Wartung
ggf. Leseaufforderung 
Unbedingt Bedienungsanleitung vor erster Inbetriebnahme lesen! Sicherheitshinweise beachten!

Beispiel Titelblatt

Die Anleitung kann aufgrund des Bildes schnell gefunden werden. 


Quelle: Olympus Camedia C-2020ZOOM


Inhaltsverzeichnis

Das Inhaltsverzeichnis ist die übersichtliche Zusammenstellung der Kapitelüberschriften.

Zweck

Das Inhaltsverzeichnis erfüllt mehrere Aufgaben:
  • Es bietet einen inhaltlichen Überblick. 
  • Es zeigt die vom Autor gewählte Struktur.
  • Es ermöglicht, einen Inhalt zu suchen und direkt aufzuschlagen.
  • Ausführung

    Typografisch gestaltete, hierarchische Gliederung mit Seitenzahlen.

    Exkurs: Kapitel-Nummerierung Pro und Contra

    Ob die Kapitel in Technischer Dokumentation nummeriert werden sollen, darüber wird häufig noch gestritten. 
    • Contra Nummerierung:
    „Nummerierung ist nicht mehr nötig, weil die Ordnung über die typografische Gestaltung der Kapitelüberschriften gezeigt werden kann.“
    Außerdem: Die Nummerierung wird von vielen Benutzern nicht verstanden. 
    • Pro Nummerierung:
    „Die Nummerierung ist wichtig, um zwischen Kapiteln verweisen zu können.“ Außerdem: Die Nummerierung ermöglicht eindeutige Verweise zwischen Papier und Online-Dokumentation, z.B. beim Telefonat mit der Hotline: "Schlagen Sie bitte Kapitel 1.3.15 auf."

    Zu dieser Anleitung

    Das Kapitel „Zu dieser Anleitung“ ist eine Anleitung zur Anleitung.
    Hier wird erklärt, wie die Anleitung aufgebaut ist und wie sie sinnvoll benutzt werden kann.

    Zweck

    Eine Anleitung zur Anleitung erfüllt folgende Aufgaben:
  • Der Benutzer bekommt einen Überblick über den Zweck der Anleitung. 
  • Der Benutzer erhält praktische Tipps, z.B. was er unbedingt lesen muss, wie die Anleitung geordnet ist usw. 
  • Die Schreibweise wird erklärt. 
  • Die verwendeten Symbole werden erklärt.
  • Tipps

  • Eine Anleitung sollte eigentlich selbsterklärend sein und keine Anleitung zur Anleitung benötigen!
  • Wenn nötig, sollte eine Anleitung zur Anleitung mit Zwischenüberschriften deutlich strukturiert werden, z.B.:

  • - Zielgruppe
    - Ziel der Anleitung
    - Überblick
    - Aufbau der Anleitung
    - Praktische Tipps zur Benutzung der Anleitung
    - Erklärung der Schreibweise
    - Zeichenerklärung

    Seitenzahlen

    Zweck

    Seitenzahlen helfen dem Leser, eine bestimmte Seite schnell zu finden.
     
    Ausführung
    • Normalerweise stehen die Seitenzahlen in der Fußzeile außen (Linke Seite: linksbündig, rechte Seite: rechtsbündig). 
    • Die Anleitung ist kontinuierlich durchnummeriert. Auch leere Seiten haben eine Nummer. (Leere Seiten müssen als solche erkenntlich sein, da sonst der Leser nicht weiß, ob die Seite absichtlich oder versehentlich leer ist. Das erreicht man z.B. durch Fortführung der Kopf- und Fußzeilen.) 
    • Die Zählung beginnt immer auf einer rechten Seite mit 1. Dadurch haben alle rechten Seiten ungerade Seitenzahlen. 
    • Titelblatt, Vorwort und Inhaltsverzeichnis werden nicht mitnummeriert. Sie können separat nummeriert werden.

    Register

    Register sind ausgeführte oder mitgedruckte Zugriffshilfen für Kapitel.

    Zweck

    Register heben die Kapitel-Unterteilung für den Leser deutlicher hervor, und dienen dem Leser zu einem schnelleren Zugriff auf bestimmte Kapitel.

    Beispiel

    Beispiel Register 
    Das mitgedruckte Register macht die Einteilung deutlich und ermöglicht einen schnellen Zugriff. 
    Quelle: BMW AG, Betriebsanleitung BMW 520 

    Lebende Kolumnentitel

    Lebende Kolumnentitel sind die Wiederholung der aktuellen Kapitelüberschrift in der Kopf- oder Fußzeile.

    Zweck

    Lebende Kolumnentitel dienen dem Leser zur Orientierung, in welchem Kapitel er sich gerade befindet.

    Ausführung

    • Lebende Kolumnentitel werden meistens in der Kopfzeile außen dargestellt.
    • Viele Text- und DTP-Programme ermöglichen, dass lebende Kolumnentitel automatisch gesetzt werden.
    • Je nach Struktur erscheint die erste, zweite oder dritte Kapitelebene als lebender Kolumnentitel.
    • Der lebende Kolumnentitel erscheint auf der ersten Seite des Kapitels nicht, damit man beim Durchblättern die Kapitelanfänge deutlich erkennt.

    Bildverzeichnis

    Ein Bildverzeichnis ist die übersichtliche Auflistung aller verwendeten Bilder.

    Zweck

    Sie dient dem Leser zu folgendem Zweck:
  • Schnell eine gewünschte Abbildung zu finden. 
  • Rechte zu einzelnen Bildern nachzuschlagen. 
  • Meines Erachtens sind Bildverzeichnisse meistens überflüssig.



    Literaturverzeichnis

    Ein Literaturverzeichnis ist die übersichtliche Zusammenstellung von benutzter und weiterführender Literatur.

    Zweck

    Sie dient dem Leser zu folgenden Zwecken:
    • Auf welchen Grundlagen hat der Autor die vorliegende Anleitung zusammengestellt? 
    • Wo kann ich das Wissen zu bestimmten Themen weiter vertiefen?
    Ein Literaturverzeichnis ist in „normalen“ Anleitungen sicher nicht nötig. Bei spezielleren Geräten, z.B. bei einer Anleitung zu einem Messgerät, kann es aber angebracht sein.

    Ausführung

    Das Literaturverzeichnis ist autorenweise alphabetisch sortiert.
    Es wird folgendermaßen gesetzt: 
    Birkenbihl, Vera F.: Kommunikationstraining: zwischenmenschliche Beziehungen erfolgreich gestalten, mvg-Verlag, Landsberg am Lech, 1986

     

    Struktur: Literaturverzeichnis

     
    Beispiele, Hinweise
    Autorname 
    Birkenbihl,
    Vorname 
    Vera F.
    Titel 
    Kommunikationstraining: zwischenmenschliche Beziehungen erfolgreich gestalten
    Verlag 
    mvg-Verlag


    (Die Verlagsangabe kann weggelassen werden.)

    Ort 
    Landsberg am Lech
    Erscheinungsjahr 
    1986

    Index, Stichwortverzeichnis

    Der Index ist eine alphabetisch sortierte Liste von ausgesuchten Suchworten.

    Zweck

    Der Index erfüllt folgende Aufgabe:
    • Schnelles Finden eines Inhaltes

    Ausführung

    Der Index ist alphabetisch sortiert. Er enthält die im Text enthaltenen Stichworte und Synonyme, außerdem alle auf dem Gerät befindlichen Beschriftungen!

    Exkurs: Index bei elektronischen Anleitungen

    Dem Index oder der Volltextsuche kommt bei elektronischer Dokumentation eine besondere Bedeutung zu, da elektronische Dokumente den Vorteil der schnellen Suche bieten, wenn ein guter Index existiert oder die Volltextsuche nicht zu viele „Treffer“ liefert.
    Index
    Vom Autor festgelegte Worte, die als Suchworte zu diesem Kapitel dienen und dieses Kapitel charakterisieren.
    Volltext
    Der gesamte Text wird nach der eingegebenen Buchstabenfolge abgesucht.
    Die Groß-/Kleinschreibung wird meistens ignoriert. Das Wort wird aber nur gefunden, wenn es genauso geschrieben ist (die Suche nach „Mann“ findet „Männer“ nicht). Der Umgang mit der Volltextsuche (z.B. auch bei den Suchmaschinen im Internet) zeigt, dass diese universelle Methode häufig zu guten Ergebnissen führt. 
    Sinnvoll ist, wenn die Suchbegriffe auch boolesch kombiniert werden können: z.B. +Seminar +Perl -Universität findet alle Textstellen, in denen die Worte Perl und Seminar vorhanden sind, das Wort Universität aber nicht.
    Technische Lösungen der Volltextsuche
    Es gibt zwei technische Lösungen:
    Normale Volltextsuche
    Das Dokument wird beim Suchen nach dem Suchbegriff durchsucht.


    So arbeitet z.B. die Suchfunktion in Word oder die Suche in Acrobat. Diese Suche ist relativ langsam, da der gesamte Text abgesucht werden muss.

    Indizierte Volltextsuche
    Bei der indizierten Volltextsuche wird beim Erstellen ein Index erstellt, in dem alle Worte (!) mit Fundstelle registriert sind. Die Suchmaschine prüft nur diese Liste und „weiß“ sofort, wie oft und an welchen Stellen der Suchbegriff vorkommt. 


    Diese Form der Suche ist wesentlich schneller. Internet-Suchmaschinen arbeiten nach diesem Prinzip.

    Ranking
    Wenn sehr viele Textstellen gefunden werden, sollten die Ergebnisse nach Relevanz geordnet dargestellt werden. 


    Hierfür verfügen moderne Suchsysteme über eine „Ranking“ genannte Beurteilungsmethode, die die Treffer nach bestimmten Kriterien mit Punkten versieht. Das Suchergebnis wird nach diesen Punkten sortiert dargestellt, so dass die relevanten Fundstellen oben stehen. 


    Rückseite

    Die Rückseite ist die sichtbare Rückseite der Anleitung.

    Zweck

    Die Rückseite wird häufig nur für logistische Zwecke des Herstellers verwendet, z.B.:
  • Zugehörige Geräte- und Versionsnummer 
  • Drucknummer 
  • Ausgabedatum
  • Sie kann außerdem wichtige Kontakte zeigen: 
    • Adresse 
    • Hotline-Nummer

    Ausführung

    Die Rückseite wird meistens mit viel Weißraum gestaltet: Alle Elemente stehen oben oder unten am Rand.

    Beispiel



    Verständniselemente

    Der Benutzer kann beim Verstehen der Anleitung unterstützt werden. 
    • Vielfach versteht der Benutzer neue Inhalte besser, wenn er richtig eingestimmt wird (è Advance Organizer). 
    • Manche Dinge lassen sich leichter merken, wenn sie in einem Merksatz zusammengefasst sind (è Merksatz), (z.B. „Die Schärfentiefe ist umso größer, je kleiner die Blende ist.“). 
    • Die meisten Anwender verstehen die Anleitung besser, wenn sie etwas praktisch ausprobieren können (è Beispiele, Übungen). 
    • Manchmal hilft es dem Benutzer, wenn die wichtigen Inhalte am Ende des Kapitels noch einmal zusammengefasst werden (è Zusammenfassung). 
    • In der Anleitung werden Fachausdrücke verwendet, die nicht alle Benutzer kennen (è Glossar).
    Im Folgenden werden die einzelnen Verständniselemente näher beschrieben.

    Advance Organizer

    Ein Advance Organizer ist eine vorwegnehmende Einstimmung auf den Inhalt des Kapitels.

    Zweck

    Der Advance Organizer dient dem Leser zu folgenden Zwecken:
    • Einstimmung, Vorabinformation.
    • Vorstrukturierung.
    • Bei Bekanntem abgeholt werden.
    • Antwort auf die Frage: Soll ich das Kapitel lesen?

    Beispiel Advance Organizer

    Winzip 8.0 
    Möchten Sie eine Datei vor dem Komprimieren mit einem Kennwort versehen, damit Sie vor dem Zugriff durch unberechtigte Personen geschützt ist? Mit "Winzip 8.0" ist das problemlos möglich. Und wer das Kennwort nicht kennt, kann die in dem geschützten Archiv vorhandenen Dateien nicht dekomprimieren. 
    In Zeitschriften ist es üblich, einen Advance Organizer vorneweg zu stellen, um dem Leser den Artikel "schmackhaft" zu machen. 
    Quelle: Computer Bild, 22/2001 

    Merksatz

    Zweck

    Ein Merksatz dient dem Leser dazu, sich wichtige Aussagen kompakt zu merken (z.B. auswendig zu lernen).
    Sie helfen Ihrem Leser, wenn Sie ihm Wichtiges als Merksatz kennzeichnen.

    Ausführung

  • Ein Merksatz muss kurz sein, damit der Leser ihn sich gut merken kann.
  • Der Merksatz muss hervorgehoben und als „Merksatz“ gekennzeichnet sein oder in einem Kasten stehen.

  • Beispiele, Übungen

    Zweck

    Wenn in der Anleitung Tätigkeiten vermittelt werden, die besser erlernt werden können, wenn der Benutzer die Tätigkeit übt, ist es sinnvoll ihm Beispiele oder Übungen zu liefern, die er handelnd nachvollziehen kann.



    Zusammenfassung

    Zusammenfassungen fassen den Inhalt eines Kapitels kurz und übersichtlich zusammen.

    Zweck

    Zusammenfassungen dienen dem Leser zu folgenden Zwecken:
    • Querlesen
    Der Leser kann die Zusammenfassung lesen und entscheiden, ob das Kapitel für ihn interessante Informationen enthält. Die Zusammenfassung steht dann sinnvollerweise am Kapitelanfang. 
    • Rekapitulieren
    Wenn der Leser das Kapitel gelesen hat, kann er anhand der Zusammenfassung das Wichtigste noch einmal gedanklich durchgehen. Dabei kann er auch überprüfen, ob er alles richtig verstanden hat. Die Zusammenfassung steht in diesem Fall besser am Kapitelende.

    Glossar

    Ein Glossar ist eine Zusammenstellung der verwendeten Fachausdrücke mit Erklärung.

    Zweck

    Ein Glossar dient dem Benutzer zu folgenden Zwecken:
    • Unbekannte Wörter nachschlagen 
    • Unbekannte Abkürzungen nachschlagen

    Ausführung

    Das Glossar enthält alle erklärungsbedürftigen Worte:
    • Fachbegriffe 
    • Fremdworte 
    • Abkürzungen 
    Ein Glossareintrag kann meistens nach der folgenden Struktur erstellt werden. Wenn Sie diese Struktur nehmen und nacheinander jeden Punkt füllen, können Sie anschließend den Eintrag ganz einfach formulieren!

    Struktur: Glossar

     
    Beispiele, Hinweise
    Fachausdruck 
    GPS
    ggf. ausgeschriebene Abkürzung 
    Global Positioning System
    ggf. Herkunft
    USA
    Oberbegriff 
    Satellitennavigationssystem
    Merkmale / Nutzen 
    zur Bestimmung der Position auf bis zu 5 m genau


    Vom US-Militär betrieben. ggf. Beispiel GPS wird in Fahrzeug-Navigationssystemen verwendet, um die aktuelle Position zu bestimmen.

    Layoutbeispiel für Glossar
    Doppeltuner 
    Doppelt ausgeführter UKW-Tuner. Ermöglicht den gleichzeitigen Empfang von TMC-Verkehrsinformationen und einem TMC-losen Programm.

    GPS
    Global Positioning System. Vom US-Militär betriebenes Satellitennavigationssystem, das zivilen Nutzern erlaubt, ihre Position auf bis zu 5 Meter genau zu bestimmen.

    Offboard
    Navigationssystem, bei dem die Kartendaten vom Provider gespeichert werden. Auch die Routenberechnung erfolgt dezentral und wird via Telekommunikation – etwa per SMS – ins Fahrzeug gesendet.

      RAM-Zwischenspeicher
    Festspeicher. Damit ausgestattete Navigationssysteme speichern hier die relevanten Daten der Karten-CD. So ist das Laufwerk für Audio-CDs frei.

    Text-to-Speech
    Software, die Textdaten in Sprache umwandelt.

    TMC
    Traffic Message Channel. Verkehrskanal, der permanent und unhörbar Autobahn-Verkehrsinformationen über den UKW/RDS-Rundfunk aussendet. Geeignet für Textdarstellung oder dynamische Navigation.

    Ein Glossar kann wie ein Lexikon gestaltet sein:
    Mehrere schmale Spalten, kleine Schrift, hervorgehobene Suchworte.


    Spezielle Inhalte

    Außer den oben beschriebenen Inhalten müssen, je nach Gerät und Anleitung, spezielle Inhalte aufgenommen werden. 
    • Am Gerät kann man sich verletzen (è Sicherheitshinweise). 
    • Das Gerät besteht aus mehreren Teilen (è Lieferumfang).
    • Die technischen Daten sollen festgelegt werden (è Technische Daten). 
    • Das Gerät muss regelmäßig gewartet werden (è Wartungsanleitung). 
    • Es muss vor missbräuchlicher Benutzung gewarnt werden (è Bestimmungsgemäßer Gebrauch).
    Im Folgenden sind solche Speziellen Inhalte einzeln beschrieben.

    Impressum

    Das Impressum enthält Daten zur Verwaltung des Druckwerkes, z.B. Drucknummer, Druckdatum, Herausgeber.

    Ausführung

    Das Impressum steht bei Anleitungen häufig auf der Innenseite des Titelblattes.

    Struktur: Impressum

     
    Beispiele, Hinweise
    Titel 
    Betriebsanleitung BMW 316, 316i
    Hersteller, Ort 


    (bzw. Herausgeber und Ort)

    BMW AG, München
    Gültig für... 
    BMW 316, 316i
    Auflage 
    2. Auflage Januar 2001: 200.000
    ggf. Mitwirkende (Autoren, Illustratoren, Lektoren, Übersetzer...) 
    Text: Dietrich Juhl 


    Zeichnungen: Guido Leuck

    ggf. verwendete Software und Produktionsmittel
    Verwendete Software:


    MS Word, Adobe Illustrator

    Copyright-Hinweis 
    © 2001 Bayrische Motoren Werke


    (BMW) AG München

    Nachdruckverbot 
    Nachdruck, auch auszugsweise, nur mit schriftlicher Genehmigung.
    Drucknummer und Druckdatum 
    Bestell-Nr. 01 40 9 781 8/2002
    Hinweis auf Markenzeichen und Warenzeichen...
    Alle in diesem Handbuch genannten Bezeichnungen von Erzeugnissen sind Warenzeichen der jeweiligen Firmen.
    Hinweis auf Papierqualität 
    Gedruckt auf chlorfreiem Papier...
    Änderungshinweis 
    Technische Änderungen vorbehalten.

    Sicherheitshinweise

    Wenn von einem Gerät Gefahren für Personen oder Sachen ausgehen, muss in der Anleitung deutlich vor diesen Gefahren gewarnt werden

    Zweck

    Die Sicherheitshinweise dienen dem Benutzer dazu, Gefahren und daraus resultierende Verletzungen zu vermeiden.

    Grundsatz: Zuerst Gefahren konstruktiv beseitigen

    Soweit möglich und wirtschaftlich vertretbar, müssen Gefahren konstruktiv vermieden werden (z.B. durch Sicherheitseinrichtungen).
    Nur wenn dies nicht möglich ist, muss durch einen entsprechenden Sicherheitshinweis gewarnt werden.

    Gefahrenanalyse

    Es ist sinnvoll, das Gefährdungspotential in einer Gefahrenanalyse zu ermitteln, um dann Warnhinweise gezielt einzusetzen.

    Ausführung

    Sicherheitshinweise gesammelt am Anfang

    Es hat sich eingebürgert und ist in den USA zwingend erforderlich, die Sicherheitshinweise noch einmal gesammelt am Anfang der Dokumentation unterzubringen.
  • Alle Sicherheitshinweise gesammelt 
  • Ganz vorne in der Anleitung 
  • Ggf. auffällig markiert (z.B. farbiges Papier) 
  • Thematisch sortiert (mit Zwischenüberschriften)
  • Sicherheitshinweise im Sinnzusammenhang

    Für Sicherheitshinweise gibt es eine feste Struktur (siehe unten).
    Die Sicherheitshinweise sind Teil der Handlungsanweisungen und müssen vor dem gefährlichen Handlungsschritt stehen! 
    Seltener kann der Sicherheitshinweis auch unabhängig von jeglicher Handlung sein, dann wäre er vor allen Tätigkeitsbeschreibungen richtig aufgehoben. Beispiel: „Die Sicherheitseinrichtungen dürfen nicht demontiert oder außer Betrieb gesetzt werden.“

    Struktur: klassischer Sicherheitshinweis

     
    Beispiel
    Aufmerksamkeitszeichen
    Aufmerksamkeitswort 
    Achtung! (je nach Gefährdungsgrad)


    Vorsicht!
    Gefahr!

    Nennung der Gefahr 
    Heiße Geräteteile.
    Nennung der möglichen Folgen 
    Verbrennungsgefahr
    Nennung der Vermeidungsmöglichkeit
    Nicht berühren!

    Beispiel



    Bestimmungsgemäßer Gebrauch

    Zweck

    Die Produzentenhaftung erfordert, den bestimmungsgemäßen Gebrauch des Gerätes zu beschreiben und ggf. vor missbräuchlicher Verwendung zu warnen.

    Ausführung

    Der bestimmungsgemäße Gebrauch ist in der Leistungsbeschreibung normalerweise ausreichend beschrieben.


    Besteht die Gefahr einer missbräuchlichen Verwendung, muss zusätzlich davor gewarnt werden.
    Hierfür ist es auch erforderlich den Markt zu beobachten, um auf solche missbräuchliche Verwendung aufmerksam zu werden.


    Technische Daten

    Technische Daten sind die Zusammenstellung der wichtigsten Daten.


    Hierdurch wird die Leistung des Gerätes spezifiziert.

    Zweck

    Die Technischen Daten dienen dem Benutzer zu folgenden Zwecken:
  • Genaue Auswahl des Gerätes 
  • Prüfung auf die Leistungsfähigkeit (z.B. „Kann dieses Gerät zum Heben der Last verwendet werden?“)
  • Ausführung

    Tabellarische Darstellung
  • In der Leistungsbeschreibung oder 
  • Im Anhang der Anleitung

  • Lieferumfang

    Zweck

    Der Lieferumfang ist wichtig, wenn das Produkt aus mehreren Teilen besteht und der Benutzer die Möglichkeit haben soll, die Vollständigkeit der Lieferung zu überprüfen.

    Ausführung

    Idealerweise wird der Lieferumfang als Zeichnung mit Tabelle dargestellt.


    In manchen Fällen genügt eine tabellarische Aufzählung der Teile.

    Beispiel

    Bei dieser übersichtlichen Darstellung fällt es leicht den Lieferumfang zu prüfen.


    Quelle: Olympus Camedia C-2020ZOOM


    Fehlersuchtabelle

    Die Fehlersuchtabelle fasst die häufigsten Fehler und Abhilfen übersichtlich zusammen.

    Zweck

    Die Fehlersuchtabelle hilft dem Benutzer, bei Fehlern gezielt nach Ursache und Abhilfe zu suchen.

    Ausführung

    Die Fehlersuchtabelle wird meistens aus folgenden Spalten aufgebaut: 
    • Fehler 
    • Mögliche Ursache 
    • Behebung

    Garantie

    Zweck

    Die Garantiebestimmungen dienen dem Hersteller dazu, darzulegen, in welchen Fällen Anspruch auf Garantie besteht.


    Gegebenenfalls kann hier auch erklärt werden, wie der Kunde im Garantiefall verfahren soll.

    Ausführung

    Lassen Sie die Garantiebestimmungen von Juristen verfassen und übernehmen Sie die Formulierungen wörtlich.



    Adressen

    Im Adressteil steht die Adresse des Herstellers und ggf. die Adressen von Niederlassungen oder Servicestellen.

    Zweck

    Die Adressen dienen dem Benutzer dazu, sich mit dem Hersteller in Verbindung zu setzen. Die Gründe können vielfältig sein:
  • Das Gerät ist defekt und der Benutzer will Ersatzteile bestellen. 
  • Der Benutzer will den Service bestellen. 
  • Der Benutzer will Verbesserungsvorschläge machen. 
  • Der Benutzer will sich beschweren. 
  • Der Benutzer will ein ähnliches Gerät kaufen.
  • Ausführung

    Die Adressen sind meistens übersichtlich gestaltet.
    Häufig wird eine einheitliche Adress-Seite in allen Publikationen verwendet. 
    Es kann sinnvoll sein, zweckgebundene Adressen und Telefonnummern anzugeben (z.B. Hotline, Kundendienst, Vertrieb).
    Dietrich Juhl
    Horionstr. 32b
    53177 Bonn
    Tel 0228/ 31 10 81
    www.juhl.de
     info@juhl.de

    Karrikaturen: Werner Küstenmacher


    Der Autor 

    Dietrich Juhl arbeitet seit 20 Jahren auf dem Gebiet der Technischen Dokumentation. 
    Er ist Technischer Redakteur, hat selbst viele Anleitungen geschrieben, in Aus- und Weiterbildungen Studierende und Praktiker unterrichtet und arbeitet heute als freier Berater und Trainer. Anleitungen nach Konzepten des Autors haben bei mehreren Vergleichstests gewonnen.
    Zum Seitenanfang

    Unterartikel



    © ADOLPH Verlag GmbH - Letztes Update 03.05.2004