Notizen:
- Dieses Kapitel, ebenso wie der Rest dieses Lehrbuchs für technisches Schreiben, konzentriert sich auf Fähigkeiten im technischen Schreiben. Die technischen Inhalte hier sind nicht garantiert erfolgreich, genau oder auf dem neuesten Stand.
- Bitte klicken Sie hier, um zu helfen David McMurrey Für Webhosting bezahlen: Spende so viel du kannst! Online Technical Writing bleibt weiterhin kostenlos.
Der Schwerpunkt dieses Kapitels ist eine der wichtigsten Anwendungen des technischen Schreibens—Anleitungen. Wie Sie wissen, Anweisungen sind das Schritt-für-Schritt-Anleitungen, wie man etwas macht: wie man Dinge baut, bedient, repariert oder instand hält.
Schau dir unbedingt die Beispiele.
Schreiben Sie eine Anleitung für die Arbeit oder für einen Kurs im technischen Schreiben? Probieren Sie das Anweisungen Planung Leitfaden.
Anweisungen zum Schreiben
Eine der häufigsten und eine der wichtigsten Verwendungszwecke des technischen Schreibens sind Anleitungen — diese Schritt-für-Schritt-Erklärungen, wie man Dinge tut: etwas zusammenbaut, etwas bedient, etwas repariert oder routinemäßige Wartungsarbeiten an etwas durchführt. Aber für etwas, das scheinbar so einfach und intuitiv ist, gehören Anleitungen zu den am schlechtesten verfassten Dokumenten, die man finden kann. Wie ich hast du wahrscheinlich viele frustrierende Erfahrungen mit schlecht geschriebenen Anleitungen gemacht. Was in diesem Kapitel folgt, ist vielleicht kein narrensicherer, idiotensicherer Leitfaden zum Schreiben von Anleitungen, aber es wird dir zeigen, was Fachleute für die besten Techniken halten.
Letztendlich erfordert gutes Verfassen von Anleitungen:
- Klares, einfaches Schreiben
- Ein gründliches Verständnis des Verfahrens in all seinen technischen Details
- Ihre Fähigkeit, sich in die Lage des Lesers zu versetzen, der versucht, Ihre Anweisungen anzuwenden
- Ihre Fähigkeit, den Ablauf bis ins kleinste Detail zu visualisieren und diese Vorstellung auf Papier festzuhalten
- Schließlich, Ihre Bereitschaft, noch einen Schritt weiterzugehen und Ihre Anweisungen an der Art von Person zu testen, für die Sie sie geschrieben haben.
Mittlerweile haben Sie wahrscheinlich Überschriften, Listen und besondere Hinweise—das Schreiben einer Reihe von Anweisungen mit diesen Werkzeugen scheint wohl offensichtlich. Sie müssen nur die Diskussion in nummerierte vertikale Listen aufteilen und an den offensichtlichen Stellen einige besondere Hinweise einfügen – und schon ist es erledigt! Nun, nicht ganz, aber das ist ein guter Anfang. Dieses Kapitel untersucht einige Merkmale von Anleitungen, die sie komplexer machen können. Diese Überlegungen können Sie wiederum nutzen, um Ihre eigenen Anleitungen zu planen.
NotebookLM-generierte Infografik dieses Kapitels
Einige Vorbemerkungen
Am Anfang eines Projekts zur Erstellung von Anleitungen ist es wichtig, die Struktur oder die Merkmale des konkreten Verfahrens zu bestimmen, über das man schreiben wird.
Publikum und Situation. Früh im Prozess, definieren Sie die Zielgruppe und die Situation Ihrer Anweisungen. Denken Sie daran, dass die Definition einer Zielgruppe ihren Vertrautheitsgrad mit dem Thema sowie weitere derartige Details umfasst. Siehe die Diskussion über Zuschauer und Schritte zur Verwendung bei der Definition von Zielgruppen.
Am wichtigsten: Wenn Sie an einem Schreibkurs teilnehmen, müssen Sie eine Beschreibung Ihrer Zielgruppe schreiben und diese Ihren Anweisungen beifügen. Dadurch kann Ihre Lehrkraft Ihre Anweisungen hinsichtlich ihrer Angemessenheit für die beabsichtigte Zielgruppe beurteilen. Und denken Sie auch daran, dass es in einem Kurs im technischen Schreiben vorzuziehen ist, für nicht-fachliche Zielgruppen zu schreiben—viel mehr eine Herausforderung für Sie als Autor darstellt.
Anzahl der Aufgaben. Wie viele Aufgaben gibt es in dem Verfahren, über das Sie schreiben? Verwenden wir den Begriff Verfahren um auf die Gesamtheit der Aktivitäten zu verweisen, über die Ihre Anweisungen sprechen sollen. Ein Aufgabe ist eine halbunabhängige Gruppe von Aktionen innerhalb des Verfahrens: zum Beispiel ist das Einstellen der Uhr an einer Mikrowelle eine Aufgabe im großen Gesamtverfahren des Betriebs einer Mikrowelle.
Eine einfache Prozedur wie das Wechseln des Öls in einem Auto enthält nur eine Aufgabe; es gibt keine halbunabhängigen Gruppierungen von Aktivitäten. Eine komplexere Prozedur wie die Benutzung einer Mikrowelle enthält viele solcher halbunabhängigen Aufgaben: die Uhr einstellen; die Leistungsstufe einstellen; den Timer benutzen; die Mikrowelle reinigen und warten, unter anderem. (Die Anleitung zur Verwendung einer Kamera werden nach Aufgaben organisiert.)
Phase dann ist eine Gruppe ähnlicher Schritte innerhalb eines Verfahrens für eine einzelne Aufgabe. Im Beispiel einer Schaukel wäre das Aufstellen des Rahmens eine Phase; das Verankern im Boden wäre eine andere; das Zusammenbauen der Kastenschaukel wäre noch eine weitere.
Verwenden Sie Aufgabenorientierung. Konzentrieren Sie sich auf die Aufgaben, die Ihre Leser ausführen möchten; verwenden Sie "how to" oder "–ing" Formulierungen in Überschriften.
Beste Vorgehensweise zur Schritt-für-Schritt-Diskussion. Eine weitere Überlegung, die Sie vielleicht nicht frühzeitig bestimmen können, ist, wie Sie Ihre Anweisungen ausrichten. Bei den meisten Anweisungen können Sie sich auf Aufgaben konzentrieren, oder Sie können sich auf Werkzeuge (oder Merkmale von Werkzeugen) konzentrieren.
In einem Vorgehensweise (auch als Aufgabenorientierung bekannt) zu Anweisungen zur Nutzung eines Telefonbeantwortungsdienstes hättest du diese Abschnitte:
- Aufnahme Ihrer Begrüßung
- deine Nachrichten abspielen
- Ihre Nachrichten speichern
- deine Nachrichten weiterleiten
- Löschen Ihrer Nachrichten, und so weiter
Dies sind Aufgaben—die typischen Dinge, die wir mit der Maschine tun möchten. Für weitere Diskussionen, siehe das Kapitel über Aufgabenanalyse.
Andererseits, in einem Ansatz mit Werkzeugen In Anleitungen zur Benutzung eines Fotokopierers gäbe es diese unwahrscheinlichen Abschnitte:
- Kopier-Button
- Abbrechen-Schaltfläche
- Vergrößern/Verkleinern Schaltfläche
- Sortieren/Heften Schaltfläche
- copy-size Button, und so weiter
Wenn Sie ein Set von Anweisungen nach diesem Plan entwerfen würden, würden Sie Schritte zum Verwenden jeder Taste oder Funktion des Fotokopierers schreiben. Anleitungen, die diesen Tools-/Funktionen-Ansatz verwenden, sind schwer praktikabel zu gestalten. Manchmal stimmt der Name der Taste nicht genau mit der Aufgabe überein, mit der sie verknüpft ist; manchmal muss man mehr als nur diese eine Taste benutzen, um die Aufgabe zu erfüllen. Dennoch kann es Zeiten geben, in denen der Tools-/Funktionen-Ansatz vorzuziehen ist.
Gruppierungen von Aufgaben. Das Auflisten von Aufgaben ist vielleicht nicht alles, was Sie tun müssen. Es kann so viele Aufgaben geben, dass Sie diese gruppieren müssen, damit Leser einzelne leichter finden können. Zum Beispiel sind die folgenden gängigen Aufgabengruppierungen in Anleitungen:
- Auspack- und Einrichtungsaufgaben
- Installieren und Anpassen von Aufgaben
- Grundlegende Betriebsaufgaben
- routinemäßige Wartungsaufgaben
- Aufgaben zur Fehlerbehebung; und so weiter
Häufige Abschnitte in Anleitungen
Das Folgende ist eine Übersicht über die Abschnitte, die Sie üblicherweise in Anleitungen finden werden. Nehmen Sie nicht an, dass jeder von ihnen muss dass sie in den tatsächlichen Anweisungen, die Sie schreiben, enthalten sein müssen, noch dass sie in der hier dargestellten Reihenfolge sein müssen, noch dass dies die einzigen möglichen Abschnitte in einer Reihe von Anweisungen sind.
Wenn Sie das Folgende zu häufigen Abschnitten in Anleitungen lesen, schauen Sie sich das Beispiel Anweisungen.
Schematische Darstellung der Anweisungen. Denken Sie daran, dass dies ein typisches oder gängiges Modell für die Inhalte und die Organisation—viele andere sind möglich.
Einleitung. Planen Sie die Einführung Ihrer Anweisungen sorgfältig. Stellen Sie sicher, dass sie eines der folgenden Dinge (aber nicht unbedingt in dieser Reihenfolge) tut, die auf Ihre speziellen Anweisungen zutreffen:
- Geben Sie die spezifischen Aufgaben oder das Verfahren an, das erklärt werden soll, sowie den Umfang der Abdeckung (was wird nicht abgedeckt werden).
- Geben Sie an, welche Kenntnisse und welchen Hintergrund das Publikum benötigt, um die Anweisungen zu verstehen.
- Geben Sie eine allgemeine Vorstellung vom Verfahren und davon, was es bewirkt.
- Geben Sie an, unter welchen Bedingungen diese Anweisungen verwendet werden sollten (oder nicht verwendet werden sollten).
- Geben Sie einen Überblick über den Inhalt der Anweisungen.
Siehe den Abschnitt zu Einführungen zur weiteren Diskussion.
Allgemeine Warn-, Vorsichts- und Gefahrenhinweise. Anleitungen müssen Leser häufig auf die Möglichkeit hinweisen, ihre Geräte zu beschädigen, das Verfahren zu vermasseln und sich selbst zu verletzen. Außerdem müssen Anleitungen oft wichtige Punkte oder Ausnahmen hervorheben. Für diese Situationen verwendet man Besondere Hinweise—Hinweis-, Warn-, Vorsichts- und Gefahrenhinweise. Beachten Sie, wie diese speziellen Hinweise in den oben aufgeführten Beispielanweisungen verwendet werden.
Technischer Hintergrund oder Theorie. Am Anfang bestimmter Arten von Anleitungen (nach der Einführung, natürlich) benötigen Sie möglicherweise eine Diskussion des Hintergrunds, der sich auf das Verfahren bezieht. Für bestimmte Anleitungen ist dieser Hintergrund kritisch—andernfalls, ergeben die Schritte im Verfahren keinen Sinn. Zum Beispiel haben Sie vielleicht schon Erfahrungen mit diesen Software-Applets gemacht, in denen Sie Ihre eigenen Farben definieren, indem Sie die Schieberegler für Rot, Grün und Blau verschieben. Um wirklich zu verstehen, was Sie tun, benötigen Sie etwas Hintergrundwissen über Farbe. Ebenso kann man sich vorstellen, dass für bestimmte Anleitungen, die Kameras verwenden, ebenfalls etwas Theorie nötig sein könnte.
Ausrüstung und Vorräte. Beachte, dass die meisten Anleitungen eine Liste der Dinge enthalten, die du sammeln musst, bevor du mit dem Verfahren beginnst. Dazu gehören Ausrüstung, die Werkzeuge, die Sie im Verfahren verwenden (wie Rührschüsseln, Löffel, Brotbackformen, Hämmer, Bohrmaschinen und Sägen) und Vorräte
Diskussion der Schritte. Wenn es an das eigentliche Verfassen der Schritte geht, gibt es mehrere Dinge zu beachten: (1) die Struktur und das Format dieser Schritte, (2) ergänzende Informationen, die möglicherweise benötigt werden, und (3) die Perspektive und der allgemeine Schreibstil.
Struktur und Format. Normalerweise stellen wir uns eine Anweisungssammlung als vertikal nummerierte Listen formatiert vor. Und die meisten sind es in der Tat. Normalerweise formatiert man seine tatsächlichen Schritt-für-Schritt-Anleitungen auf diese Weise. Es gibt jedoch einige Variationen sowie einige andere Überlegungen:
- Schritte in festgelegter Reihenfolge sind Schritte, die in der angegebenen Reihenfolge ausgeführt werden müssen. Zum Beispiel, wenn Sie das Öl in einem Auto wechseln, ist das Ablassen des Öls ein Schritt, der muss kommen, bevor das neue Öl eingefüllt wird. Dies sind nummerierte Listen (meist, vertikale nummerierte Listen).
- Schritte variabler Ordnung sind Schritte, die in praktisch beliebiger Reihenfolge ausgeführt werden können. Gute Beispiele sind Fehlersuchanleitungen, die Ihnen sagen, dies zu überprüfen, das zu überprüfen, wenn Sie versuchen, etwas zu beheben. Sie können diese Art von Schritten in praktisch beliebiger Reihenfolge ausführen. Bei dieser Art ist die Liste mit Aufzählungszeichen das passende Format.
- Alternative Schritte sind solche, bei denen zwei oder mehr Wege präsentiert werden, um dasselbe zu erreichen. Alternative Schritte werden auch verwendet, wenn verschiedene Bedingungen vorliegen könnten. Verwenden Sie bei diesem Typ Aufzählungslisten, wobei ODER zwischen den Alternativen eingefügt wird, oder einen einleitenden Hinweis, der anzeigt, dass Alternativen präsentiert werden.
- Verschachtelte Schritte. In einigen Fällen können einzelne Schritte innerhalb eines Verfahrens für sich genommen ziemlich komplex sein und müssen in Teilschritte aufgeteilt werden. In diesem Fall rücken Sie weiter ein und nummerieren die Teilschritte als a, b, c und so weiter.
- "Stepless" Anweisungen. Und schließlich gibt es Anweisungen, die wirklich keine nummerierte vertikale Liste verwenden können und die kaum bis gar keine direkte, instruktionsartige Anleitung für den Leser bieten. Manche Situationen müssen so verallgemeinert oder so variabel sein, dass Schritte nicht 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 einfach zu sagen, sie sollen dies oder jenes tun. Sie benötigen zusätzliche erläuternde Informationen, wie zum Beispiel, wie die Sache vor und nach dem Schritt aussehen sollte; warum es ihnen wichtig sein sollte, diesen Schritt auszuführen; welches mechanische Prinzip dem, was sie tun, zugrunde liegt; sogar noch detailliertere Erklärungen auf Mikroebene des Schritts—Diskussion der spezifischen Handlungen, die den Schritt ausmachen.
Das Problem mit ergänzenden Ausführungen ist jedoch, dass sie den eigentlichen Schritt verbergen können. Sie wollen, dass der eigentliche Schritt—die konkreten Maßnahmen, die der Leser ergreifen soll—heraussticht. Sie wollen nicht, dass alles in einem Wust von Worten vergraben ist. 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 Sie können die Anweisung fett markieren.
Tatsächliche Benutzerschritte in Anweisungen fett darstellen. Fetter Text hilft, die eigentliche Aktion von den ergänzenden Informationen zu unterscheiden.
Vermeide telegrammartiges Schreiben—das Auslassen von "understood" Artikeln (the, a, an). Zugegeben, Roboter schreiben so, aber wir müssen das nicht.)
Schreibstil.
Ein weiteres typisches Problem beim Schreibstil in Anleitungen ist, dass die Leute scheinbar die Artikel weglassen wollen: "Press Pause button on front panel to stop display of information temporarily" oder "Earthperson, please provide address of nearest pizza restaurant." Warum machen wir das? Wollen wir alle heimlich Roboter sein? Wie auch immer, stellt sicher, dass ihr alle Artikel einschließt (ein, ein, der/die/das) und andere solche Wörter, die wir normalerweise in Anweisungen verwenden würden.
Grafiken in Anleitungen
Wahrscheinlich mehr als in jeder anderen Form des Schreibens (außer vielleicht bei Comics) sind Grafiken für Anleitungen entscheidend. Manchmal können Worte einfach den Schritt nicht erklären. Illustrationen sind oft entscheidend dafür, dass Leser sich vorstellen können, was sie tun sollen.
In einem Kurs zum technischen Schreiben können die Anweisungen verlangen, dass Sie Abbildungen oder andere Arten von Grafiken—was auch immer normalerweise in den Anweisungen verwendet würde, beifügen. Das Problem kann natürlich sein, dass Sie keinen Zugang zu Grafiken haben, die für Ihre konkreten Anweisungen geeignet wären, und dass Sie sich in Bezug auf Ihre künstlerischen Fähigkeiten nicht gerade übermäßig sicher fühlen. Es gibt Möglichkeiten, diese Probleme zu überwinden! Schauen Sie sich die Vorschläge in Grafiken. In jenem Kapitel sehen Sie nicht nur Vorschläge zur Erstellung von Grafiken, sondern auch Anforderungen an deren Format.
Format in Anweisungen
Überschriften. In Ihren Anleitungen sollten Sie Überschriften sinnvoll einsetzen. Normalerweise sollten Sie Überschriften für jeden Hintergrundabschnitt, den Sie möglicherweise haben, für den Abschnitt Ausrüstung und Vorräte, für eine allgemeine Überschrift des eigentlichen Anleitungsabschnitts und für Unterüberschriften der einzelnen Aufgaben oder Phasen innerhalb dieses Abschnitts verwenden. Sehen Sie sich die Beispiele am Anfang dieses Kapitels an. Siehe Überschriften für gemeinsame Anforderungen.
Listen. Ebenso verwenden Anleitungen typischerweise häufig Listen, insbesondere nummerierte vertikale Listen für die eigentlichen Schritt-für-Schritt-Erklärungen. Einfache vertikale Listen oder zweispaltige Listen eignen sich normalerweise gut für den Abschnitt Ausrüstung und Verbrauchsmaterialien. Satzinterne Listen sind gut, wann immer Sie einen Überblick über die kommenden Punkte geben. Siehe Listen für gemeinsame Anforderungen.
Besondere Hinweise. In Anleitungen müssen Sie die Leser auf Möglichkeiten hinweisen, in denen sie ihre Ausrüstung beschädigen, Vorräte verschwenden, das gesamte Verfahren zum Scheitern bringen, sich selbst oder andere—sogar schwer oder tödlich verletzen können. Unternehmen wurden verklagt, weil solche speziellen Hinweise fehlten, weil spezielle Hinweise schlecht formuliert waren, oder weil spezielle Hinweise fehl am Platz waren. Siehe besondere Hinweise für eine vollständige Diskussion über die richtige Verwendung dieser speziellen Hinweise sowie über deren Format und Platzierung innerhalb von Anweisungen.
Nummer, Abkürzungen, und Symbole. Anweisungen verwenden auch viele Zahlen, Abkürzungen, und Symbole. Für Richtlinien in diesen Bereichen.
Einrückung von Hinweisen in Anweisungen. Im ersten Beispiel, beachten Sie, wie der Hinweis nach rechts eingerückt ist Text des vorherigen Schritts. Im zweiten Beispiel fällt auf, dass die schwerwiegende Mitteilung am Anfang vor allen Schritten platziert ist.
KI-Aufforderungen für Anweisungen
Checklisten, die typischerweise ungelesen bleiben, können mit einigen Änderungen als Quelle für KI-Prompts verwendet werden. Kopieren Sie das Folgende, fügen Sie es in ein KI-System wie Googles Gemini ein und sehen Sie, was Sie möglicherweise übersehen haben.
Hinweis: Alle Verweise auf den Inhalt, das Format, den Stil der Anweisungen oder ihre Bestandteile sind zu finden in der Online-Lehrbuch zum technischen Schreiben.
Wenn Sie KI zur Bewertung eines Schreibprojekts verwenden möchten, stellen Sie sich vor, sagen Sie der KI, wer Sie sind und was Sie wollen. Geben Sie der KI einen Bezugspunkt für die Bewertung, zum Beispiel ein Online-Lehrbuch. Posten Sie dann, was die KI in ihrer Bewertung überprüfen soll.
Passe die Einleitung an deine Identität an.
|
Anweisungen für KI-Eingabeaufforderungen Hallo, KI. Ich bitte Sie, Anweisungen zu bewerten, die von einem Studierenden eines US-Colleges im zweiten Studienjahr verfasst wurden. Unten folgt eine Zusammenfassung von Lehrbuchkapiteln über Anweisungen und Hinweise als Grundlage für Ihre Bewertung zu verwenden. (Identifizierende Informationen maskiert):
|
Verwandte Informationen
Lesequiz. Verwenden Sie dieses Quiz, um Ihr Verständnis für dieses Kapitel zu testen.
Quizze: Grammatik, Wortgebrauch, Zeichensetzung.
Wie kann ich effektive Bedienungsanleitungen erstellen?
Die versteckten Kosten von so intuitiv, dass es kein Handbuch braucht
Tragen Betriebsanleitungen zur Unternehmensleistung bei?
Wie man Anweisungen schreibt. Techschreiber
Ich würde Ihre Gedanken, Reaktionen, Kritik bezüglich dieses Kapitels: deine Antwort—David McMurrey.
