Notizen:
- Dieses Kapitel sowie der Rest dieses technischen Schreibhandbuchs konzentriert sich auf technische Schreibfähigkeiten. Der technische Inhalt hier ist nicht garantiert erfolgreich, genau oder aktuell.
- Bitte klicken Sie hier, um zu helfen David McMurrey Zahlung für Webhosting: Spenden Sie jeden Betrag, den Sie können! Online-Technisches Schreiben bleibt kostenlos.
Der Schwerpunkt dieses Kapitels liegt auf einer der wichtigsten Anwendungen des technischen Schreibens: Anleitungen. Wie Sie wissen, Anweisungen sind das schrittweise Erklärungen, wie man etwas macht: wie man Dinge baut, betreibt, repariert oder wartet.
Stelle sicher, dass du die Beispiele.
Schreiben Sie eine Anleitung für die Arbeit oder für einen technischen Schreibkurs? Probieren Sie dies aus. Anleitung Planungsleitfaden.
Schreibanweisungen
Eine der häufigsten und eine der wichtigsten Anwendungen technischer Schreibweise sind Anleitungen—diese Schritt-für-Schritt-Erklärungen, wie man Dinge tut: etwas zusammenbauen, etwas bedienen, etwas reparieren oder Routinewartung an etwas durchführen. Aber für etwas, das scheinbar so einfach und intuitiv ist, sind Anleitungen einige der schlechtesten Dokumente, die man finden kann. Wie ich, hast du wahrscheinlich viele frustrierende Erfahrungen mit schlecht geschriebenen Anleitungen gemacht. Was in diesem Kapitel folgt, mag kein narrensicherer, fehlerfreier Leitfaden zum Schreiben von Anleitungen sein, aber es zeigt dir, welche Techniken Fachleute als die besten betrachten.
Letztendlich erfordert gutes Anweisungsverfassen:
- Klare, einfache Schrift
- Ein gründliches Verständnis des Verfahrens in allen technischen Details
- Ihre Fähigkeit, sich in die Lage des Lesers zu versetzen, der versucht, Ihre Anweisungen zu verwenden.
- Ihre Fähigkeit, den Ablauf im Detail vorzustellen und dieses Bewusstsein auf Papier festzuhalten
- Schließlich Ihre Bereitschaft, den zusätzlicher Weg zu gehen und Ihre Anweisungen an der Art von Person zu testen, für die Sie sie geschrieben haben.
Bis jetzt hast du wahrscheinlich Überschriften, Listen und besondere Hinweise studiert—eine Reihe von Anweisungen mit diesen Werkzeugen zu schreiben, scheint dir wahrscheinlich offensichtlich. Teile die Diskussion einfach in nummerierte vertikale Listen auf und füge an den offensichtlichen Stellen einige besondere Hinweise hinzu, und du bist fertig! Nun, nicht ganz, aber das ist ein guter Anfang. Dieses Kapitel untersucht einige der Merkmale von Anweisungen, die sie komplexer machen können. Du kannst diese Überlegungen wiederum nutzen, um deine eigenen Anweisungen zu planen.
NotebookLM-erzeugte Infografik dieses Kapitels
Einige Vorbereitungen
Zu Beginn eines Projekts zur Erstellung von Anweisungen ist es wichtig, die Struktur oder die Merkmale des speziellen Verfahrens zu bestimmen, über das Sie schreiben möchten.
Zielgruppe und Situation. Frühe im Prozess sollten Sie das Publikum und die Situation Ihrer Anweisungen definieren. Denken Sie daran, dass das Definieren eines Publikums bedeutet, dessen Vertrautheit mit dem Thema sowie andere Details festzulegen. Sehen Sie die Diskussion über Publikum und Schritte zur Definition von Zielgruppen.
Am wichtigsten ist, dass Sie, wenn Sie an einem Schreibkurs teilnehmen, eine Beschreibung Ihres Publikums verfassen und diese an Ihre Anweisungen anhängen. Dies ermöglicht es Ihrem Dozenten, Ihre Anweisungen hinsichtlich ihrer Eignung für das vorgesehene Publikum zu bewerten. Denken Sie auch daran, dass es in einem technischen Schreibkurs vorzuziehen ist, für nicht-spezialisierte Zielgruppen zu schreiben, was für Sie als Schriftsteller—eine viel größere Herausforderung darstellt.
Anzahl der Aufgaben. Wie viele Aufgaben gibt es im Verfahren, über das Sie schreiben? Lassen Sie uns den Begriff verwenden. Verfahren um auf die gesamte Reihe von Aktivitäten zu verweisen, über die Ihre Anweisungen diskutieren sollen. Ein Aufgabe ist eine halbautonome Gruppe von Aktionen innerhalb des Verfahrens: Zum Beispiel das Einstellen der Uhr in einer Mikrowelle ist eine Aufgabe im großen Gesamtverfahren des Betriebs einer Mikrowelle.
Ein einfaches Verfahren wie das Wechseln des Öls in einem Auto beinhaltet nur eine Aufgabe; es gibt keine semi-unabhängigen Gruppierungen von Aktivitäten. Ein komplexeres Verfahren wie die Benutzung eines Mikrowellenofens enthält viele solcher semi-unabhängigen Aufgaben: die Uhr einstellen; die Leistungsstufe einstellen; den Timer verwenden; die Mikrowelle reinigen und warten, unter anderem. (Die Anleitungen zur Verwendung einer Kamera sind nach Aufgaben organisiert.)
Einige Anleitungen haben nur eine einzige Aufgabe, enthalten jedoch viele Schritte innerhalb dieser Aufgabe. Zum Beispiel, stellen Sie sich eine Anleitung zum Zusammenbauen einer Kinderschaukel vor. In meiner eigenen Erfahrung gab es mehr als 130 Schritte! Das kann etwas einschüchternd sein. Ein guter Ansatz ist es, ähnliche und verwandte Schritte in Phasen zu gruppieren und die Schritte in jeder neuen Phase neu zu nummerieren. Ein Phase Dann ist eine Gruppe ähnlicher Schritte innerhalb eines Einzelfauftragsverfahrens. Im Beispiel des Schaukels wäre das Aufstellen des Rahmens eine Phase; das Verankern des Geräts im Boden wäre eine andere; das Zusammenbauen der Kastenschaukel wäre eine weitere.
Verwenden Sie eine Aufgabenorientierung. Konzentrieren Sie sich auf die Aufgaben, die Ihre Leser ausführen möchten; verwenden Sie "Wie man" oder –-Formulierungen in Überschriften.
Der beste Ansatz für die schrittweise Diskussion. Ein weiterer Punkt, den Sie möglicherweise nicht sofort bestimmen können, ist, wie Sie Ihre Anweisungen fokussieren. Bei den meisten Anweisungen können Sie sich auf Aufgaben konzentrieren oder auf Werkzeuge (oder Funktionen von Werkzeugen).
In einer Aufgabenansatz (auch bekannt als Aufgabenorientierung) zu Anweisungen zur Nutzung eines Telefonbeantworters, hättest du folgende Abschnitte:
- Ihre Begrüßung aufnehmen
- Ihre Nachrichten abspielen
- Ihre Nachrichten speichern
- Ihre Nachrichten weiterleiten
- deine Nachrichten löschen und so weiter
Das 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 Werkzeugansatz zu Anweisungen zur Benutzung eines Kopierers würde es diese unwahrscheinlichen Abschnitte geben:
- Kopieren-Button
- Abbrechen-Button
- Vergrößern/Verkleinern Knopf
- Zusammenführen/Klammerner-Taste
- Kopiergröße-Button und so weiter
Wenn Sie eine Anleitung zu diesem Plan entwerfen würden, würden Sie Schritte zum Gebrauch jedes Knopfes oder jeder Funktion des Kopiergeräts schreiben. Anleitungen, die diesen Werkzeugansatz verwenden, sind schwer umzusetzen. Manchmal stimmt der Name des Knopfes nicht ganz mit der Aufgabe überein, mit der er verbunden ist; manchmal müssen Sie mehr als nur einen Knopf verwenden, um die Aufgabe zu erfüllen. Es kann jedoch Zeiten geben, in denen der Ansatz mit Werkzeugen/Funktionen vorzuziehen sein kann.
Gruppierungen von Aufgaben. Die Auflistung von Aufgaben ist möglicherweise nicht alles, was Sie tun müssen. Es kann so viele Aufgaben geben, dass Sie sie gruppieren müssen, damit die Leser einzelne leichter finden können. Zum Beispiel sind die folgenden häufige Gruppierungen von Aufgaben in Anleitungen:
- Auspack- und Einrichtungsaufgaben
- Aufgaben installieren und anpassen
- grundlegende Betriebsaufgaben
- Routine-Instandhaltungsaufgaben
- Fehlerbehebungsaufgaben; und so weiter
Häufige Abschnitte in Anleitungen
Die folgende Übersicht beschreibt die Abschnitte, die Sie häufig in Anleitungen finden. Gehen Sie nicht davon aus, dass jeder von ihnen muss seien in den tatsächlichen Anweisungen, die Sie schreiben, noch dass sie in der hier dargestellten Reihenfolge sein müssen, noch dass dies die einzigen möglichen Abschnitte in einem Satz von Anweisungen sind.
Während Sie Folgendes über häufige Abschnitte in Anweisungen lesen, schauen Sie sich die an Beispielanweisungen.
Schematische Ansicht der Anweisungen. Denke daran, dass dies ein typisches oder gängiges Modell für die Inhalte und die Organisation ist—viele andere sind möglich.
Einleitung. Planen Sie die Einführung Ihrer Anweisungen sorgfältig. Stellen Sie sicher, dass sie Folgendes tut (aber nicht unbedingt in dieser Reihenfolge), was auf Ihre speziellen Anweisungen zutrifft:
- Geben Sie die spezifischen Aufgaben oder Verfahren an, die erklärt werden sollen, sowie den Umfang der Abdeckung (was wird nicht Covered werden).
- Geben Sie an, welches Wissen und welche Vorkenntnisse das Publikum benötigt, um die Anweisungen zu verstehen.
- Geben Sie eine allgemeine Vorstellung von dem Verfahren und was es erreicht.
- Geben Sie die Bedingungen an, unter denen diese Anweisungen verwendet werden sollten (oder nicht verwendet werden sollten).
- Geben Sie einen Überblick über den Inhalt der Anweisungen.
Siehe den Abschnitt über Einführungen für weitere Diskussionen.
Allgemeine Warnung, Vorsicht, Gefahrhinweise. Anleitungen müssen oft die Leser auf die Möglichkeit hinweisen, ihre Geräte zu ruinieren, das Verfahren falsch auszuführen und sich selbst zu verletzen. Außerdem müssen Anleitungen oft wichtige Punkte oder Ausnahmen betonen. Für diese Situationen verwenden Sie besondere Hinweise—Hinweise, Warnungen, Vorsichtsmaßnahmen und Gefahrenhinweise. Beachten Sie, wie diese speziellen Hinweise in den obigen Beispielanweisungen verwendet werden.
Technischer Hintergrund oder Theorie. Am Anfang bestimmter Arten von Anleitungen (nach der Einleitung, natürlich) benötigen Sie möglicherweise eine Diskussion über den Hintergrund, der mit dem Verfahren verbunden ist. Für bestimmte Anleitungen ist dieser Hintergrund entscheidend—ansonsten ergeben die Schritte im Verfahren keinen Sinn. Zum Beispiel haben Sie vielleicht Erfahrung 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 Farben. Ähnlich können Sie sich vorstellen, dass für bestimmte Anleitungen mit Kameras auch etwas Theorie erforderlich sein könnte.
Ausrüstung und Materialien. Beachten Sie, dass die meisten Anweisungen eine Liste der Dinge enthalten, die Sie sammeln müssen, bevor Sie das Verfahren beginnen. Dazu gehören Ausrüstung, die Werkzeuge, die Sie im Verfahren verwenden (wie Rührschüsseln, Löffel, Brotformen, Hämmer, Bohrer und Sägen) und Vorräte, die Dinge, die im Verfahren verbraucht werden (wie Holz, Farbe, Öl, Mehl und Nägel). In Anleitungen sind diese in der Regel entweder in einer einfachen vertikalen Liste oder in einer zweispaltigen Liste aufgeführt. Verwenden Sie die zweispaltige Liste, wenn Sie einige oder alle —Artikel mit Spezifikationen hinzufügen müssen, zum Beispiel Markennamen, Größen, Mengen, Typen, Modellnummern usw.
Diskussion der Schritte. Wenn Sie zu dem eigentlichen Schreiben der Schritte kommen, gibt es mehrere Dinge zu beachten: (1) die Struktur und das Format dieser Schritte, (2) zusätzliche Informationen, die möglicherweise benötigt werden, und (3) den Standpunkt sowie den allgemeinen Schreibstil.
Struktur und Format. Normalerweise stellen wir uns eine Reihe von Anweisungen als vertikale nummerierte Listen vor. Und die meisten sind es tatsächlich. Normalerweise formatierst du deine tatsächlichen Schritt-für-Schritt-Anweisungen auf diese Weise. Es gibt jedoch einige Variationen sowie einige andere Überlegungen:
- Feste Reihenfolge Schritte 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 kamen, bevor das neue Öl eingefüllt wurde. Dies sind nummerierte Listen (normalerweise vertikale nummerierte Listen).
- Variablenordnungs-Schritte sind Schritte, die praktisch in beliebiger Reihenfolge ausgeführt werden können. Gute Beispiele sind solche Fehlersuche-Anleitungen, die dir sagen, du sollst dies überprüfen, das überprüfen, wenn du versuchst, etwas zu reparieren. Du kannst diese Art von Schritten praktisch in beliebiger Reihenfolge durchführen. Bei dieser Art ist die Aufzählungsliste das geeignete Format.
- Alternative Schritte sind solche, bei denen zwei oder mehr Möglichkeiten präsentiert werden, um dasselbe zu erreichen. Alternative Schritte werden auch verwendet, wenn verschiedene Bedingungen bestehen könnten. Verwenden Sie bei dieser Art AufzählungslListen mit ODER zwischen den Alternativen oder die Einleitung, die anzeigt, dass Alternativen präsentiert werden.
- Verschachtelte Schritte. In einigen Fällen können einzelne Schritte innerhalb eines Verfahrens recht komplex sein und müssen in Unter Schritte unterteilt werden. In diesem Fall rücken Sie weiter ein und sequenzieren die Unter Schritte als a, b, c und so weiter.
- "Stufenlose" Anweisungen. Und schließlich gibt es Anweisungen, die wirklich keine nummerierte vertikale Liste verwenden können und die fast keine klare, instruktionsartige Anleitung für den Leser bieten. Einige 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 das tun. Sie benötigen zusätzliche erklärende Informationen, wie das Ergebnis vor und nach dem Schritt aussehen sollte; warum es wichtig ist, diesen Schritt zu machen; welches mechanische Prinzip dem zugrunde liegt, was sie tun; sogar eine noch detailliertere Erklärung des Schrittes — Diskussion der spezifischen Aktionen, die den Schritt ausmachen.
Das Problem mit ergänzenden Diskussionen ist jedoch, dass sie den eigentlichen Schritt verbergen können. Sie möchten, dass der eigentliche Schritt—die spezifischen Handlungen, die der Leser durchführen soll—heraussticht. Sie möchten nicht, dass alles in einem Worthaufen begraben wird. Es gibt mindestens zwei Techniken, um dieses Problem zu vermeiden: Sie können die Anweisung von der Ergänzung in separate Absätze aufteilen; oder Sie können die Anweisung fett drucken.
Fettgedruckte tatsächliche Benutzer Schritte in Anweisungen. Fetter Text hilft, die tatsächliche Aktion von den ergänzenden Informationen zu unterscheiden.
Vermeide telegraphischen Stil—das Auslassen von "verstädlichen" Artikeln (der, die, das). Es stimmt, Roboter schreiben so, aber wir müssen das nicht tun.
Schreibstil. Die Art und Weise, wie du Anweisungen tatsächlich schreibst, Satz für Satz, mag im Widerspruch zu dem stehen, was dir frühere Schreibkurse beigebracht haben. Beachte jedoch, wie "Anweisungen aus der realen Welt" geschrieben werden—sie verwenden viele imperativische (Befehls- oder direkte Ansprache) Schreibweisen; sie verwenden viel "du." Das ist völlig angemessen. Du möchtest, dass dein Leser dir ins Gesicht schaut, seine oder ihre volle Aufmerksamkeit erhält. Aus diesem Grund klingen satzartige Anweisungen so: "Drücke jetzt die Pause-Taste an der Vorderseite, um die Anzeige vorübergehend zu stoppen" und "Du solltest darauf achten, nicht ..."
Ein bestimmtes Problem betrifft die Verwendung der Passivform in Anleitungen. Aus irgendeinem seltsamen Grund klingen einige Anweisungen so: "Der Pause-Button sollte gedrückt werden, um die Anzeige vorübergehend zu stoppen." Wir sorgen uns nicht nur um die seelische Gesundheit des Pause-Buttons, sondern fragen uns auch, wer das Ding drücken soll (redest du mit mir?). Oder betrachte dieses Beispiel: "Der Timer-Button wird dann auf 3:00 eingestellt." Wieder könnte es passieren, dass du als Person, die diese Anweisungen befolgt, dies übersiehst; du könntest denken, es sei einfach ein Verweis auf einen bestehenden Zustand, oder du könntest dich fragen, "Reden sie mit mir?" Fast ebenso schlimm ist die Verwendung der dritten Person: "Der Benutzer sollte dann den Pause-Button drücken." Erneut ist es dieser alte Doppelschlag: du schaust dich im Raum um und fragst dich, "Ich?" (Für mehr Details, siehe) Passiv-Stimmungsproblem.)
Ein weiteres typisches Problem mit dem Schreibstil in Anleitungen ist, dass die Menschen anscheinend Artikel weglassen möchten: "Drücken Sie die Pause-Taste auf dem Bedienfeld, um die Anzeige von Informationen vorübergehend zu stoppen" oder "Erde-Bewohner, bitte geben Sie die Adresse der nächsten Pizzeria an." Warum tun wir das? Wollen wir alle heimlich Roboter sein? Jedenfalls sollten Sie alle Artikel einbeziehen.a, an, der) und andere solcher 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 in Comics) sind Grafiken für Anleitungen entscheidend. Manchmal können Worte einfach den Schritt nicht erklären. Illustrationen sind oft entscheidend für die Fähigkeit der Leser, sich vorzustellen, was sie tun sollen.
In einem technischen Schreibkurs können die Anweisungen erfordern, dass Sie Illustrationen oder andere Arten von Grafiken_—_einfügen, die normalerweise in den Anweisungen verwendet werden. Das Problem ist natürlich, dass Sie möglicherweise keinen Zugang zu Grafiken haben, die für Ihre speziellen Anweisungen geeignet sind, und dass Sie sich in Ihren künstlerischen Fähigkeiten nicht besonders sicher fühlen. Es gibt Möglichkeiten, diese Probleme zu überwinden! Werfen Sie einen Blick auf die Vorschläge in Grafiken. In diesem Kapitel finden Sie nicht nur Vorschläge zur Erstellung von Grafiken, sondern auch Anforderungen an deren Format.
Format in Anweisungen
Überschriften. In Ihren Anweisungen sollten Sie sich gut der Überschriften bedienen. Normalerweise möchten Sie Überschriften für jeden Hintergrundabschnitt, den Sie haben könnten, den Abschnitt über Ausrüstung und Materialien, eine allgemeine Überschrift für den tatsächlichen Anweisungsabschnitt und Unterüberschriften für die einzelnen Aufgaben oder Phasen innerhalb dieses Abschnitts. Schauen Sie sich die Beispiele zu Beginn dieses Kapitels an. Überschriften für allgemeine Anforderungen.
Listen. Ähnlich verwenden Anleitungen typischerweise umfangreich Listen, insbesondere nummerierte vertikale Listen für die tatsächlichen 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 Materialien. Aufzählungen im Satz sind nützlich, wann immer Sie einen Überblick über bevorstehende Dinge geben. Siehe Listen für gemeinsame Anforderungen.
Besondere Hinweise. In den Anweisungen müssen Sie die Leser auf Möglichkeiten hinweisen, bei denen sie ihre Geräte beschädigen, Materialien verschwenden, den gesamten Ablauf scheitern lassen oder sich selbst oder andere—verletzt, möglicherweise sogar schwer oder tödlich. Unternehmen wurden wegen fehlender dieser besonderen Hinweise, wegen schlecht geschriebener besonderer Hinweise oder wegen unpassender besonderer Hinweise verklagt. Siehe besondere Hinweise für eine vollständige Diskussion über die ordnungsgemäße Verwendung dieser speziellen Hinweise sowie über ihr Format und ihre Platzierung innerhalb der Anweisungen.
Zahlen, Abkürzungen und Symbole. Anweisungen verwenden ebenfalls viele Zahlen, Abkürzungen und Symbole. Für Richtlinien in diesen Bereichen.
Einrückung von Hinweisen in Anweisungen. Im ersten Beispiel beachten Sie, wie die Mitteilung eingerückt ist, um die text des vorhergehenden Schrittes. Im zweiten Beispiel fällt auf, dass die schwere Mitteilung zu Beginn platziert ist, bevor einer der Schritte.
KI-Aufforderungen für Anweisungen
Checklisten, die in der Regel ungelesen bleiben, können mit einigen Modifikationen als Quelle für KI-gestützte Eingabeaufforderungen verwendet werden. Kopiere das Folgende, füge es in ein KI-System wie Google’s Gemini ein und sieh nach, was du eventuell übersehen hast.
Hinweis: Alle Referenzen zum Inhalt, Format, Stil der Anweisungen oder deren Komponenten finden Sie in der Online-Lehrbuch für technische Dokumentation.
Wenn Sie KI verwenden möchten, um ein Schreibprojekt zu bewerten, stellen Sie sich vor, erzählen Sie der KI, wer Sie sind und was Sie wollen. Geben Sie der KI einen Referenzpunkt für die Bewertungen, wie ein Online-Lehrbuch. Posten Sie dann, was Sie möchten, dass die KI in ihrer Bewertung überprüft.
Passen Sie die Einleitung an Ihre Identität an.
|
AI Aufforderungen Anweisungen Hallo, KI. Ich bitte dich, Anweisungen zu bewerten, die von einem amerikanischen College-Studenten im zweiten Jahr verfasst wurden. Unten ist eine Zusammenfassung von Kapitelinhalten eines Lehrbuchs über Anleitungen und Hinweise als Grundlage Ihrer Bewertung. (Identifizierende Informationen maskiert):
|
Verwandte Informationen
Lesequiz. Verwenden Sie dieses Quiz, um Ihr Verständnis dieses Kapitels zu testen.
Quiz: Grammatik, Verwendung, Interpunktion.
Wie kann ich effektive Gebrauchsanleitungen erstellen?
Die verborgenen Kosten von so intuitiv, dass es kein Handbuch benötigt.
Tragen Betriebsanleitungen zur Unternehmensleistung bei?
Wie man Anweisungen schreibt. techscribe
Ich würde Ihre Gedanken, Reaktionen und Kritiken zu diesem Kapitel sehr schätzen: deine Antwort—David McMurrey.
