Anleitungen

Der Schwerpunkt dieses Kapitels ist eine der wichtigsten Verwendungen des technischen Schreibens – Anleitungen. Wie Sie wissen, sind Anleitungen die Schritt-für-Schritt-Erklärungen, wie etwas zu tun ist: wie man etwas baut, bedient, repariert oder wartet.

Schauen Sie sich unbedingt die Beispiele an.

Anleitungen schreiben

Einer der häufigsten und wichtigsten Verwendungszwecke von technischen Texten sind Anleitungen – die Schritt-für-Schritt-Erklärungen, wie etwas zu tun ist: etwas zusammenbauen, bedienen, reparieren oder routinemäßige Wartungsarbeiten an etwas durchführen. Aber für etwas, das scheinbar so einfach und intuitiv ist, gehören Anleitungen zu den am schlechtesten geschriebenen Dokumenten, die Sie finden können. Wahrscheinlich haben Sie, wie ich, schon viele ärgerliche Erfahrungen mit schlecht geschriebenen Anleitungen gemacht. Was in diesem Kapitel folgt, ist zwar kein idiotensicherer Leitfaden für das Verfassen von Anleitungen, aber es wird Ihnen zeigen, was Fachleute für die besten Techniken halten.

Schließlich erfordert das Schreiben einer guten Anleitung:

• Klare, einfache Formulierung
• Gründliches Verständnis des Verfahrens in all seinen technischen Details
• Ihre Fähigkeit, sich in den Leser hineinzuversetzen, in die Person, die versucht, Ihre Anleitung zu benutzen
• Ihre Fähigkeit, sich das Verfahren bis ins kleinste Detail vorzustellen und dieses Bewusstsein auf Papier zu bannen
• Schließlich Ihre Bereitschaft, einen Schritt weiter zu gehen und Ihre Anleitung an der Person zu testen, für die Sie sie schreiben.

Sie haben sich wahrscheinlich schon mit Überschriften, Listen und besonderen Hinweisen beschäftigt – das Verfassen einer Anleitung mit diesen Hilfsmitteln erscheint Ihnen wahrscheinlich selbstverständlich. Gliedern Sie die Diskussion einfach in nummerierte vertikale Listen und fügen Sie an den offensichtlichen Stellen einige besondere Hinweise ein, und schon sind Sie fertig! Nun, nicht ganz, aber das ist ein guter Anfang. In diesem Kapitel werden einige der Merkmale von Anweisungen untersucht, die sie komplexer machen können. Sie können diese Überlegungen wiederum nutzen, um Ihre eigenen Anleitungen zu planen.

Einige Vorüberlegungen

Zu Beginn des Projekts, eine Anleitung zu schreiben, ist es wichtig, die Struktur oder die Merkmale des bestimmten Verfahrens zu bestimmen, über das Sie schreiben wollen.

Zielgruppe und Situation. Definieren Sie zu Beginn des Prozesses die Zielgruppe und die Situation, in der Sie Ihre Anleitung verfassen wollen. Denken Sie daran, dass die Definition eines Publikums auch bedeutet, dass Sie den Grad seiner Vertrautheit mit dem Thema und andere Details festlegen. Siehe die Diskussion über Zielgruppen und die Schritte zur Definition von Zielgruppen.

Wenn Sie an einem Schreibkurs teilnehmen, ist es besonders wichtig, dass Sie eine Beschreibung Ihrer Zielgruppe verfassen und diese Ihren Anweisungen beifügen. Auf diese Weise kann Ihr Dozent Ihre Anleitungen im Hinblick auf ihre Eignung für das vorgesehene Publikum beurteilen. Denken Sie auch daran, dass es in einem Kurs für technisches Schreiben vorzuziehen ist, für ein nicht fachkundiges Publikum zu schreiben – eine viel größere Herausforderung für Sie als Autor.

Anzahl der Aufgaben. Wie viele Aufgaben gibt es in dem Verfahren, über das Sie schreiben? Verwenden Sie den Begriff „Verfahren“ für die Gesamtheit der Tätigkeiten, die in Ihrer Anleitung behandelt werden sollen. Eine Aufgabe ist eine halb unabhängige Gruppe von Handlungen innerhalb der Prozedur: zum Beispiel ist das Einstellen der Uhr an einem Mikrowellenherd eine Aufgabe in der großen Gesamtprozedur der Bedienung eines Mikrowellenherds.

Eine einfache Prozedur wie der Ölwechsel in einem Auto enthält nur eine Aufgabe; es gibt keine halb-unabhängigen Gruppierungen von Aktivitäten. Eine komplexere Prozedur wie die Benutzung eines Mikrowellenofens enthält viele solcher halb-unabhängigen Aufgaben: das Einstellen der Uhr, das Einstellen der Leistungsstufe, das Benutzen des Timers, das Reinigen und Warten des Mikrowellenofens und vieles mehr. (Die Anweisungen zur Verwendung einer Kamera sind nach Aufgaben geordnet.)

Es gibt Anweisungen, die nur eine einzige Aufgabe haben, aber innerhalb dieser Aufgabe viele Schritte enthalten. Stellen Sie sich zum Beispiel eine Anleitung für den Zusammenbau einer Kinderschaukel vor. Ich habe selbst erlebt, dass es mehr als 130 Schritte waren! Das kann ein bisschen entmutigend sein. Ein guter Ansatz besteht darin, ähnliche und verwandte Schritte in Phasen zu gruppieren und die Schritte bei jeder neuen Phase neu zu nummerieren. Eine Phase ist dann eine Gruppe ähnlicher Schritte innerhalb eines einzigen Vorgangs. Im Beispiel der Schaukel wäre das Aufstellen des Gestells eine Phase, das Verankern im Boden eine weitere und der Zusammenbau der Kastenschaukel eine weitere.

Beste Annäherung an die Schritt-für-Schritt-Diskussion. Eine weitere Überlegung, die Sie vielleicht nicht von Anfang an anstellen können, ist, wie Sie Ihre Anleitungen ausrichten. Bei den meisten Anleitungen kann man sich auf Aufgaben konzentrieren, oder man kann sich auf Werkzeuge (oder Merkmale von Werkzeugen) konzentrieren.

Bei einem aufgabenorientierten Ansatz (auch bekannt als Aufgabenorientierung) für eine Anleitung zur Nutzung eines Telefonbeantwortungsdienstes würden Sie diese Abschnitte haben:

• Aufnahme der Begrüßung
• Abspielen der Nachrichten
• Speichern der Nachrichten
• Weiterleiten der Nachrichten
• Löschen der Nachrichten und so weiter

Das sind Aufgaben – die typischen Dinge, die wir mit dem Gerät tun wollen. Für weitere Informationen siehe das Kapitel über die Aufgabenanalyse.

Andererseits gäbe es bei einer Anleitung zur Benutzung eines Fotokopierers diese unwahrscheinlichen Abschnitte:

• Kopiertaste
• Abbruchtaste
• Taste zum Vergrößern/Verkleinern
• Taste zum Zusammentragen/Heften
• Taste für die Kopiergröße, und so weiter

Wenn Sie eine Anleitung nach diesem Plan entwerfen würden, würden Sie Schritte für die Verwendung jeder Taste oder Funktion des Fotokopierers schreiben. Anleitungen, die auf diese Weise erstellt werden, sind schwer zu realisieren. Manchmal stimmt der Name der Taste nicht ganz mit der Aufgabe überein, mit der sie verbunden ist; manchmal muss man mehr als nur die eine Taste verwenden, um die Aufgabe zu erledigen. Dennoch kann es Zeiten geben, in denen der Ansatz „Werkzeuge/Funktionen“ vorzuziehen ist.

Gruppierung von Aufgaben. Das Auflisten von Aufgaben ist vielleicht nicht alles, was Sie tun müssen. Möglicherweise gibt es so viele Aufgaben, dass Sie sie gruppieren müssen, damit die Leser die einzelnen Aufgaben leichter finden können. Die folgenden Beispiele sind übliche Aufgabengruppierungen in Anleitungen:

1. Auspacken und Einrichtungsaufgaben
2. Installations- und Anpassungsaufgaben
3. Grundlegende Betriebsaufgaben
4. Routinewartungsaufgaben
5. Störungsbehebungsaufgaben; und so weiter

Gebräuchliche Abschnitte in Anleitungen

Im Folgenden finden Sie eine Übersicht über die Abschnitte, die Sie häufig in Anleitungen finden. Gehen Sie nicht davon aus, dass jeder dieser Abschnitte in der von Ihnen geschriebenen Anleitung vorkommen muss, noch dass sie in der hier vorgestellten Reihenfolge vorkommen müssen, noch dass dies die einzigen Abschnitte sind, die in einer Anleitung vorkommen können.

Während Sie die folgenden Abschnitte über häufige Abschnitte in Anleitungen lesen, sehen Sie sich die Beispielanleitungen an.

Schematische Darstellung einer Anweisung. Denken Sie daran, dass dies ein typisches oder allgemeines Modell für den Inhalt und die Organisation ist – viele andere sind möglich.

Einleitung. Planen Sie die Einleitung zu Ihrer Anleitung sorgfältig. Vergewissern Sie sich, dass sie die folgenden Punkte erfüllt (aber nicht unbedingt in dieser Reihenfolge), die auf Ihre spezielle Anleitung zutreffen:

• Geben Sie die spezifischen Aufgaben oder Verfahren an, die erklärt werden sollen, sowie den Geltungsbereich (was nicht abgedeckt wird).
• Geben Sie an, was die Zielgruppe an Wissen und Hintergrundwissen benötigt, um die Anleitung zu verstehen.
• Geben Sie eine allgemeine Vorstellung von dem Verfahren und dem, was damit erreicht werden soll.
• Geben Sie die Bedingungen an, unter denen diese Anleitung verwendet werden sollte (oder nicht).
• Geben Sie einen Überblick über den Inhalt der Anleitung.

Siehe den Abschnitt über Einleitungen für eine weitere Diskussion.

Allgemeine Warn-, Vorsichts- und Gefahrenhinweise. Anleitungen müssen den Leser oft auf die Möglichkeit aufmerksam machen, seine Ausrüstung zu beschädigen, das Verfahren zu vermasseln und sich zu verletzen. Außerdem müssen Anleitungen oft auf wichtige Punkte oder Ausnahmen hinweisen. Für diese Situationen verwenden Sie spezielle Hinweise – Hinweis-, Warn-, Vorsichts- und Gefahrenvermerke. Beachten Sie, wie diese besonderen Hinweise in den oben aufgeführten Beispielanweisungen verwendet werden.

Technischer Hintergrund oder Theorie. Zu Beginn bestimmter Arten von Anleitungen (natürlich nach der Einleitung) kann es erforderlich sein, den Hintergrund des Verfahrens zu erläutern. Bei bestimmten Anleitungen ist dieser Hintergrund von entscheidender Bedeutung – andernfalls ergeben die einzelnen Schritte des Verfahrens keinen Sinn. Sie haben vielleicht schon Erfahrungen mit Software-Applets gemacht, in denen Sie Ihre eigenen Farben durch Verschieben von roten, grünen und blauen Schiebereglern definieren. Um wirklich zu verstehen, was Sie da tun, müssen Sie etwas Hintergrundwissen über Farben haben. In ähnlicher Weise können Sie sich vorstellen, dass für bestimmte Anleitungen, bei denen Kameras zum Einsatz kommen, auch etwas Theorie erforderlich ist.

Ausrüstung und Zubehör. Beachten Sie, dass die meisten Anleitungen eine Liste der Dinge enthalten, die Sie sammeln müssen, bevor Sie mit dem Verfahren beginnen. Dazu gehören die Ausrüstung, d.h. die Werkzeuge, die du bei dem Verfahren verwendest (z.B. Rührschüsseln, Löffel, Brotpfannen, Hämmer, Bohrer und Sägen) und das Material, d.h. die Dinge, die bei dem Verfahren verbraucht werden (z.B. Holz, Farbe, Öl, Mehl und Nägel). In Anleitungen werden diese normalerweise entweder in einer einfachen vertikalen Liste oder in einer zweispaltigen Liste aufgeführt. Verwenden Sie die zweispaltige Liste, wenn Sie einige oder alle Elemente mit Spezifikationen versehen müssen, z. B. Markennamen, Größen, Mengen, Typen, Modellnummern usw.

Diskussion der Schritte. Wenn Sie zum eigentlichen Schreiben der Schritte kommen, gibt es mehrere Dinge zu beachten: (1) die Struktur und das Format dieser Schritte, (2) zusätzliche Informationen, die eventuell benötigt werden, und (3) den Standpunkt und den allgemeinen Schreibstil.

Struktur und Format. Normalerweise stellen wir uns eine Anleitung in Form von senkrechten, nummerierten Listen vor. Und das sind die meisten auch tatsächlich. Normalerweise formatieren Sie Ihre eigentlichen Schritt-für-Schritt-Anleitungen auf diese Weise. Es gibt jedoch einige Variationen sowie einige andere Überlegungen:

• Schritte mit fester Reihenfolge sind Schritte, die in der angegebenen Reihenfolge ausgeführt werden müssen. Wenn Sie zum Beispiel das Öl in einem Auto wechseln, ist das Ablassen des Öls ein Schritt, der vor dem Einfüllen des neuen Öls erfolgen muss. Es handelt sich um nummerierte Listen (in der Regel vertikal nummerierte Listen).
• Schritte mit variabler Reihenfolge sind Schritte, die in praktisch beliebiger Reihenfolge ausgeführt werden können. Ein gutes Beispiel dafür sind die Anleitungen zur Fehlersuche, die Ihnen sagen, dass Sie dies und jenes überprüfen sollen, wenn Sie versuchen, etwas zu reparieren. Sie können diese Art von Schritten in praktisch beliebiger Reihenfolge ausführen. Bei dieser Art von Schritten ist die Aufzählung von Punkten das geeignete Format.
• Alternative Schritte sind solche, bei denen zwei oder mehr Möglichkeiten vorgestellt werden, dieselbe Sache zu erreichen. Alternative Schritte werden auch verwendet, wenn verschiedene Bedingungen vorliegen können. Verwenden Sie bei diesem Typ Aufzählungslisten, wobei zwischen den Alternativen ein ODER eingefügt wird, oder den Lead-in, der anzeigt, dass Alternativen vorgestellt werden.
• Verschachtelte Schritte. In manchen Fällen können einzelne Schritte innerhalb einer Prozedur für sich genommen recht komplex sein und müssen in Teilschritte zerlegt werden. In diesem Fall wird weiter eingerückt und die Teilschritte werden in der Reihenfolge a, b, c usw. dargestellt.
• „Stufenlose“ Anweisungen. Und schließlich gibt es Anleitungen, die wirklich keine nummerierte vertikale Liste verwenden können und die den Leser kaum oder gar nicht im Sinne einer Anleitung führen. Manche Situationen müssen so verallgemeinert oder so variabel sein, dass keine Schritte angegeben werden können.

Siehe das Kapitel über Listen für den Stil und das Format dieser Möglichkeiten.

Ergänzende Diskussion. Oft reicht es nicht aus, den Lesern nur zu sagen, sie sollen dies oder jenes tun. Sie brauchen zusätzliche erklärende Informationen, wie z.B. wie die Sache vor und nach dem Schritt aussehen sollte; warum sie sich für diesen Schritt interessieren sollten; welches mechanische Prinzip hinter dem steht, was sie tun; sogar eine Erklärung auf Mikroebene des Schrittes – eine Diskussion der spezifischen Aktionen, die den Schritt ausmachen.

Das Problem mit zusätzlichen Diskussionen ist jedoch, dass sie den eigentlichen Schritt verdecken können. Sie wollen, dass der eigentliche Schritt – die konkreten Handlungen, die der Leser ausführen soll – hervorgehoben wird. Sie wollen nicht, dass alles in einem Haufen von Wörtern begraben wird. Es gibt mindestens zwei Techniken, um dieses Problem zu vermeiden: Sie können die Anweisung von der Ergänzung in getrennte Absätze aufteilen oder die Anweisung fett drucken.

Fettdruck der tatsächlichen Benutzerschritte in Anweisungen. Fett gedruckter Text hilft, die eigentliche Handlung von den zusätzlichen Informationen zu unterscheiden.

Schreibstil. Die Art und Weise, wie Sie eine Anleitung Satz für Satz schreiben, mag im Widerspruch zu dem stehen, was Sie in früheren Schreibkursen gelernt haben. Achten Sie jedoch darauf, wie Anleitungen in der „realen Welt“ geschrieben werden – sie verwenden eine Menge imperativer (Befehls- oder Direktansprache-) Schreibweisen; sie verwenden viel „Sie“. Das ist völlig angemessen. Sie wollen den Leser direkt ansprechen, seine volle Aufmerksamkeit gewinnen. Aus diesem Grund klingen Sätze im Anleitungsstil wie diese: „Drücken Sie jetzt die Pausetaste an der Vorderseite, um das Display vorübergehend anzuhalten“ und „Sie sollten darauf achten, dass Sie nicht …“

Ein besonderes Problem ist die Verwendung des Passivs in Anweisungen. Aus irgendeinem seltsamen Grund klingen manche Anweisungen wie folgt: „Die Pausentaste sollte gedrückt werden, um die Anzeige vorübergehend anzuhalten.“ Wir machen uns nicht nur Sorgen um die geistige Gesundheit der Pausentaste, sondern fragen uns auch, wer das Ding drücken soll (reden Sie mit mir?). Oder nehmen Sie dieses Beispiel: „Der Timer-Knopf wird auf 3:00 Uhr gestellt.“ Auch hier könnten Sie als derjenige, der diesen Anweisungen folgt, dies übersehen; Sie könnten denken, dass es sich einfach um einen Verweis auf einen bestehenden Zustand handelt, oder Sie könnten sich fragen: „Sprechen die mit mir?“ Fast genauso schlimm ist die Verwendung der dritten Person: „Der Benutzer sollte dann die Pause-Taste drücken.“ Auch hier ist es wieder der alte „double-take“: Sie schauen sich im Raum um und fragen sich: „Wer ich?“ (Weitere Einzelheiten finden Sie unter Passiv-Problem.)

Ein weiteres typisches Problem mit dem Schreibstil in Anleitungen ist, dass die Leute anscheinend Artikel weglassen wollen: „Drücken Sie die Pausentaste auf dem Bedienfeld, um die Anzeige der Informationen vorübergehend zu stoppen“ oder „Erdling, bitte geben Sie die Adresse des nächsten Pizzarestaurants an.“ Warum tun wir das? Wollen wir insgeheim alle Roboter sein? Wie auch immer, achten Sie darauf, alle Artikel (a, an, der) und andere Wörter zu verwenden, die wir normalerweise in Anleitungen benutzen.

Grafiken in Anleitungen

Wahrscheinlich mehr als in jeder anderen Form des Schreibens (außer vielleicht in Comics) sind Grafiken in Anleitungen von entscheidender Bedeutung. Manchmal reichen Worte einfach nicht aus, um einen Schritt zu erklären. Illustrationen sind oft entscheidend für die Fähigkeit der Leser, sich vorzustellen, was sie tun sollen.

In einem Kurs für technisches Schreiben kann es vorkommen, dass Sie in Ihren Anleitungen Illustrationen oder andere Arten von Grafiken verwenden müssen – was auch immer normalerweise in den Anleitungen verwendet wird. Das Problem kann natürlich sein, dass Sie keinen Zugang zu Grafiken haben, die für Ihre speziellen Anweisungen geeignet wären, und dass Sie sich Ihre künstlerischen Fähigkeiten nicht so recht zutrauen. Es gibt Möglichkeiten, diese Probleme zu überwinden! Werfen Sie einen Blick auf die Vorschläge unter Grafiken. In diesem Kapitel finden Sie nicht nur Vorschläge zur Erstellung von Grafiken, sondern auch Anforderungen an deren Format.

Format in Anleitungen

Überschriften. Verwenden Sie in Ihren Anleitungen sinnvollerweise Überschriften. Normalerweise brauchen Sie Überschriften für den Hintergrund, die Ausrüstung und das Material, eine allgemeine Überschrift für den eigentlichen Anweisungsteil und Unterüberschriften für die einzelnen Aufgaben oder Phasen innerhalb dieses Teils. Schauen Sie sich die Beispiele am Anfang dieses Kapitels an. Siehe Überschriften für allgemeine Anforderungen.

Listen. Auch in Anleitungen werden in der Regel Listen verwendet, insbesondere nummerierte vertikale Listen für die eigentlichen Schritt-für-Schritt-Erklärungen. Einfache vertikale Listen oder zweispaltige Listen sind in der Regel gut für den Abschnitt über Ausrüstung und Zubehör geeignet. In-Satz-Listen sind immer dann gut, wenn Sie einen Überblick über die kommenden Dinge geben. Siehe Listen für allgemeine Anforderungen.

Besondere Hinweise. In Anleitungen müssen Sie die Leser auf Möglichkeiten hinweisen, bei denen sie ihre Ausrüstung beschädigen, Material verschwenden, das gesamte Verfahren zum Scheitern bringen, sich selbst oder andere verletzen – sogar schwer oder tödlich. Unternehmen wurden verklagt, weil diese besonderen Hinweise fehlten, schlecht geschrieben waren oder nicht an der richtigen Stelle angebracht waren. Unter „Besondere Hinweise“ finden Sie eine vollständige Erörterung der ordnungsgemäßen Verwendung dieser besonderen Hinweise sowie ihres Formats und ihrer Platzierung in der Betriebsanleitung.

Einrückung von Hinweisen in der Anleitung. Beachten Sie im ersten Beispiel, wie der Hinweis zum Text des vorangehenden Schritts eingerückt ist. Im zweiten Beispiel ist zu beachten, dass der strenge Hinweis am Anfang steht, bevor einer der Schritte ausgeführt wird.

Zahlen, Abkürzungen und Symbole. In Anleitungen werden auch viele Zahlen, Abkürzungen und Symbole verwendet. Für Richtlinien zu diesen Bereichen.

Überarbeitungs-Checkliste für Anleitungen

Wenn Sie Ihre Anleitungen durchlesen und überarbeiten, achten Sie auf Probleme wie die folgenden:

• Stellen Sie sicher, dass Sie echte Anleitungen liefern – Erklärungen, wie man etwas baut, bedient oder repariert.
• Schreiben Sie eine gute Einleitung – geben Sie darin das genaue Verfahren an, das erklärt werden soll, nennen Sie die Anforderungen an die Zielgruppe und geben Sie einen Überblick über den Inhalt.
• Achten Sie darauf, dass Sie die verschiedenen Arten von Listen verwenden, wo immer es angebracht ist. Verwenden Sie insbesondere nummerierte vertikale Listen für aufeinanderfolgende Schritte.
• Verwenden Sie Überschriften, um alle Hauptabschnitte abzugrenzen, und Unterüberschriften für Unterabschnitte. (Denken Sie daran, dass zwischen dem Titel und dem ersten Absatz keine Überschrift „Einleitung“ erforderlich ist. Denken Sie daran, in dieser Aufgabe keine Überschriften der ersten Ebene zu verwenden; beginnen Sie mit der zweiten Ebene.)
• Verwenden Sie gegebenenfalls besondere Hinweise.
• Stellen Sie sicher, dass Sie für alle Überschriften, Listen, besonderen Hinweise und Grafiken den Stil und das Format verwenden, die in diesen Kapiteln vorgestellt werden. Wenn Sie damit Probleme haben, wenden Sie sich an Ihren Ausbilder.
• Verwenden Sie Grafiken zur Veranschaulichung wichtiger Handlungen oder Objekte.
• Erläutern Sie die einzelnen Schritte bei Bedarf zusätzlich.
• Erstellen Sie gegebenenfalls einen Abschnitt mit einer Auflistung der Ausrüstung und des Materials.

Ich würde mich über Ihre Gedanken, Reaktionen und Kritik zu diesem Kapitel freuen: Ihre Antwort-David McMurrey.