Einer der häufigsten und wichtigsten Verwendungszwecke des technischen Schreibens ist das Verfassen von Anleitungen, d. h. von schrittweisen Erklärungen, wie man etwas zusammenbaut, bedient, repariert oder routinemäßig wartet. Obwohl sie intuitiv und einfach zu schreiben scheinen, gehören Anleitungen zu den am schlechtesten geschriebenen Dokumenten, die man finden kann. Die meisten von uns haben wahrscheinlich schon viele ärgerliche Erfahrungen mit schlecht geschriebenen Anleitungen gemacht. In diesem Kapitel erfahren Sie, was Fachleute als die besten Techniken zur Erstellung von Anleitungen ansehen.
Eine effektive Anleitung erfordert Folgendes:
- Klares, präzises und einfaches Schreiben
- Gründliches Verständnis des Verfahrens in all seinen technischen Details
- Die Fähigkeit, sich in den Leser hineinzuversetzen, in die Person, die versucht, Ihre Anleitung zu benutzen
- Die Fähigkeit, sich das Verfahren im Detail vorzustellen und dieses Bewusstsein auf Papier zu bringen
- Die Bereitschaft, Ihre Anleitung an der Person zu testen, für die Sie sie geschrieben haben.
Zu Beginn des Projekts, eine Anleitung zu schreiben, ist es wichtig, die Struktur oder die Merkmale des speziellen Verfahrens zu bestimmen, über das Sie schreiben wollen. Hier sind einige Schritte, die Sie befolgen sollten:
Führen Sie eine sorgfältige Analyse der Zielgruppe und der Aufgabenstellung durch
Bestimmen Sie zu Beginn des Prozesses die Zielgruppe und die Situation, in der Sie Ihre Anleitung verfassen wollen. Denken Sie daran, dass die Definition des Publikums bedeutet, den Grad der Vertrautheit Ihrer Leser mit dem Thema zu bestimmen.
Bestimmen Sie die Anzahl der Aufgaben
Wie viele Aufgaben gibt es in dem Verfahren, über das Sie schreiben? Verwenden wir 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 eines Mikrowellenofens eine Aufgabe innerhalb der großen Gesamtprozedur der Bedienung eines Mikrowellenofens.
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 mehrere halb-unabhängige Aufgaben: das Einstellen der Uhr, das Einstellen der Leistungsstufe, das Benutzen des Timers, das Reinigen und Warten des Mikrowellenofens, unter anderem.
Einige Anweisungen haben nur eine einzige Aufgabe, aber viele Schritte innerhalb dieser einzigen Aufgabe. Stellen Sie sich zum Beispiel eine Anleitung für den Zusammenbau einer Kinderschaukel vor. Nach meiner Erfahrung gab es mehr als 130 Schritte! 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 Rahmens eine Phase, das Verankern des Geräts im Boden eine andere und der Zusammenbau der Kastenschaukel eine weitere.
3. Bestimmen Sie den besten Ansatz für die schrittweise Erörterung
Für die meisten Anleitungen können Sie sich auf Aufgaben oder auf Werkzeuge (oder Merkmale von Werkzeugen) konzentrieren. Bei einem aufgabenorientierten Ansatz (auch bekannt als Aufgabenorientierung) für eine Anleitung zur Verwendung 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
Dies sind Aufgaben – die typischen Dinge, die wir mit dem Anrufbeantworter tun wollen.
Andererseits gäbe es bei einer Anleitung zur Benutzung eines Fotokopierers wahrscheinlich auch Abschnitte über die Verwendung bestimmter Funktionen:
- Kopiertaste
- Abbruchtaste
- Taste zum Vergrößern/Verkleinern
- Taste zum Zusammentragen/Heften
- Taste für die Kopiergröße und so weiter
Wenn man eine Anleitung nach diesem Plan entwerfen würde, würde man 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.
4. Gruppierung von Aufgaben
Eine Auflistung von Aufgaben ist vielleicht nicht alles, was Sie tun müssen. Vielleicht gibt es so viele Aufgaben, dass Sie sie gruppieren müssen, damit die Leser die einzelnen Aufgaben leichter finden können. Zum Beispiel sind die folgenden Aufgaben in Anleitungen häufig gruppiert:
- Auspacken und Einrichtungsaufgaben
- Installations- und Anpassungsaufgaben
- Grundlegende Betriebsaufgaben
- Routinewartungsaufgaben
- Fehlerbehebungsaufgaben.
Gebräuchliche Abschnitte in Anleitungen
Nachfolgend 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 verfassten Anleitung enthalten sein muss, noch dass sie in der hier vorgestellten Reihenfolge vorkommen müssen, noch dass dies die einzigen möglichen Abschnitte in einer Anleitung sind.
Für alternative Formate sehen Sie sich die Beispielanleitungen an.
Einleitung: Planen Sie die Einleitung Ihrer Anleitung sorgfältig. Sie könnte eine der folgenden Punkte enthalten (aber nicht unbedingt in dieser Reihenfolge):
- Hinweis auf die spezifischen Aufgaben oder das Verfahren, das erklärt werden soll, sowie auf den Umfang (was abgedeckt wird und was nicht)
- Hinweis darauf, was die Zuhörer an Wissen und Hintergrundwissen benötigen, um die Anleitung zu verstehen
- Geben Sie eine allgemeine Vorstellung von dem Verfahren und was damit erreicht wird
- Hinweis auf die Bedingungen, unter denen diese Anleitung verwendet werden sollte (oder nicht)
- Geben Sie einen Überblick über den Inhalt der Anleitung.
Allgemeine Warn-, Vorsichts- und Gefahrenhinweise: Anleitungen müssen den Leser oft auf die Möglichkeit aufmerksam machen, seine Ausrüstung zu ruinieren, 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 Gefahrenhinweise. Beachten Sie, wie diese besonderen Hinweise in den oben aufgeführten Beispielanweisungen verwendet werden.
Technischer Hintergrund oder Theorie: Zu Beginn bestimmter Arten von Anweisungen (nach der Einleitung) kann eine Diskussion über den Hintergrund des Verfahrens erforderlich sein. 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 definieren, indem Sie rote, grüne und blaue Schieberegler verschieben. 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 vor Beginn des Verfahrens zusammenstellen müssen. Dazu gehören die Ausrüstung, d.h. die Werkzeuge, die bei dem Verfahren verwendet werden (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.
Besprechung der Schritte: Wenn Sie zum eigentlichen Schreiben der Schritte kommen, sind mehrere Dinge zu beachten: (1) die Struktur und das Format dieser Schritte, (2) zusätzliche Informationen, die eventuell benötigt werden, und (3) die Sichtweise und der allgemeine Schreibstil.
Struktur und Format: Normalerweise stellen wir uns eine Anleitung als senkrecht nummerierte Liste 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 und 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, in denen gesagt wird, dass man dies und jenes überprüfen soll, wenn man versucht, 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 Einleitungssatz, der darauf hinweist, dass Alternativen vorgestellt werden.
- Verschachtelte Schritte können in Fällen verwendet werden, in denen einzelne Schritte innerhalb eines Verfahrens für sich genommen recht komplex sind und in Teilschritte untergliedert werden müssen. In diesem Fall werden die Teilschritte weiter eingerückt und in der Reihenfolge a, b, c usw. dargestellt.
- „Stufenlose“ Anweisungen können verwendet werden, wenn eine nummerierte vertikale Liste oder eine direkte Anleitung des Lesers nicht möglich ist. Manche Situationen müssen so verallgemeinert oder so variabel sein, dass keine Schritte angegeben werden können.
Ergänzende Diskussion: Oft reicht es nicht aus, den Lesern einfach zu sagen, dass sie dies oder jenes tun sollen. Sie brauchen zusätzliche erklärende Informationen, 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 des Schritts auf der Mikroebene – eine Erörterung der spezifischen Handlungen, die den Schritt ausmachen.
Das Problem mit der ergänzenden Diskussion ist jedoch, dass sie den eigentlichen Schritt verdecken kann. 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.
Schreibstil
Die wichtigsten Benutzerschritte fett zu drucken, kann sehr hilfreich sein, um dem Leser klar zu signalisieren, was er zu tun hat. Oft ist das Befehlsverb fett gedruckt; manchmal hebt fette Schrift die besprochene Schlüsselkomponente hervor.
Die Verwendung des Passivs in Anweisungen kann problematisch sein. Aus irgendeinem 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 (Ninjas?). Es wäre hilfreicher, anzugeben, wann der Leser „die Pausentaste drücken“ muss. Nehmen wir dieses Beispiel: „Der Timer-Knopf wird dann auf 3:00 Uhr gestellt.“ Auch hier könnte man fragen, „wird von wem eingestellt? Ninjas?“ Die Person, die diesen Anweisungen folgt, könnte denken, dass es sich einfach um einen Verweis auf einen bestehenden Zustand handelt, oder sie könnte sich fragen: „Sprechen die mit mir?“ Auch die Verwendung der dritten Person kann zu Unannehmlichkeiten führen: „Der Benutzer sollte dann die Pausetaste drücken.“ Anleitungen sollten in der Regel mit Befehlsverben und mit „Sie“ geschrieben werden, um deutlich zu machen, was der Leser tun soll.
Illustration Ihrer Anleitungen
Vielleicht mehr als in jeder anderen Form des technischen Schreibens sind Grafiken für Anleitungen entscheidend. 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. Achten Sie darauf, dass die Grafiken das Bild aus der Perspektive des Lesers wiedergeben.
Formatieren Sie Ihre Anleitungen
Da Menschen selten Anleitungen lesen wollen, aber oft müssen, formatieren Sie Ihre Anleitungen so, dass sie nur ungern gelesen werden. Versuchen Sie, den Leser dazu zu bringen, sie lesen zu wollen, oder sich zumindest nicht gegen den Gedanken zu wehren, sie zu lesen. Ein gut lesbares Format ermöglicht es Lesern, die einen Teil der Anleitungen selbst herausgefunden haben, zu dem Abschnitt zu springen, an dem sie nicht weiterkommen. Nutzen Sie das, was Sie über Überschriften, Listen, visuelle Darstellungen und passiven Raum gelernt haben, um effektive und lesbare Anleitungen zu erstellen:
Überschriften: Normalerweise benötigen Sie Überschriften für jeden Hintergrundabschnitt, den Abschnitt über Ausrüstung und Zubehör, eine allgemeine Überschrift für den eigentlichen Anleitungsabschnitt und Unterüberschriften für die einzelnen Aufgaben oder Phasen innerhalb dieses Abschnitts.
Listen: Auch in Anleitungen wird in der Regel ausgiebig Gebrauch von Listen gemacht, insbesondere von nummerierten vertikalen Listen für die eigentlichen schrittweisen Erklärungen. Einfache vertikale Listen oder zweispaltige Listen eignen sich in der Regel für den Abschnitt über die Ausrüstung und das Material. In-Satz-Listen sind immer dann gut, wenn Sie einen Überblick über die nächsten Schritte geben.
Besondere Hinweise: Möglicherweise müssen Sie die Leser auf Möglichkeiten aufmerksam machen, 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 ausführliche Diskussion über die ordnungsgemäße Verwendung dieser besonderen Hinweise sowie deren Format und Platzierung in der Betriebsanleitung.
Wenn Sie Ihre Anleitungen erneut lesen und überarbeiten, überprüfen Sie, ob sie die folgenden Punkte erfüllen:
- Beschreiben Sie klar und deutlich die genaue Vorgehensweise, die erklärt werden soll
- Bieten Sie einen Überblick über den Inhalt
- Hinweisen Sie auf die Anforderungen des Publikums
- Verwenden Sie verschiedene Arten von Listen, wo immer es angebracht ist; Verwenden Sie insbesondere nummerierte Listen für aufeinanderfolgende Schritte
- Verwenden Sie Überschriften und Zwischenüberschriften, um die Haupt- und Unterabschnitte in eine logische, kohärente Reihenfolge zu bringen
- Verwenden Sie gegebenenfalls besondere Hinweise
- Verwenden Sie Grafiken, um wichtige Handlungen und Gegenstände zu veranschaulichen
- Erläutern Sie die Schritte bei Bedarf zusätzlich
- Erstellen Sie gegebenenfalls einen Abschnitt mit einer Auflistung der Geräte und Materialien.