wie man Anweisungen schreibt

wie man Anweisungen schreibt

Ein Technical Writing und Fiction Blog von Sarah Maddox

Technische Redakteure müssen häufig Beispielcode erstellen, um den primären Anwendungsfall einer API oder eines Entwicklertools zu veranschaulichen und Entwicklern einen schnellen Einstieg in die Verwendung der API oder des Tools zu ermöglichen. Hier sind einige Tipps, wie Sie diesen Code erstellen können. Ich habe alles notiert, was mir einfällt. Wenn Sie weitere Tipps hinzufügen möchten, tun Sie dies bitte.

Ich habe kürzlich eine Dokumentation zu einer Dienstprogrammbibliothek veröffentlicht, die von Chris Broadfoot, einem Entwickler von Google-Entwicklerprogrammen, erstellt wurde. Die Dienstprogrammbibliothek ist eine Ergänzung zur Google Maps Android API. Die Dokumentation enthält eine Übersicht über alle Dienstprogramme in der Bibliothek, einen Setup-Leitfaden und eine ausführliche Anleitung zu einem der Dienstprogramme. (Ich werde im Lauf der Zeit mehr Dienstprogramme dokumentieren.) Als Teil des Leitfadens zum Dienstprogramm zur Markierung von Markierungen habe ich einen Beispielcode erstellt, der die grundlegende Verwendung des Dienstprogramms veranschaulicht und Entwickler schnell zum Laufen bringt.

Schnelle Einführung in die API und die Dienstprogrammbibliothek

Die Google Maps Android API ist für Entwickler gedacht, die ihren Android-Apps eine Karte hinzufügen möchten. Die API bezieht ihre Daten aus der Google Maps-Datenbank, verarbeitet die Anzeige der Karte und reagiert auf vom Benutzer vorgenommene Gesten, z. B. das Vergrößern und Verkleinern der Karte. Sie können auch API-Methoden aufrufen, um Markierungen, Rechtecke und andere Polygone, segmentierte Linien (so genannte Polylinien), Bilder (so genannte Bodenüberlagerungen) und Ersatzkacheln (so genannte Kachelüberlagerungen) hinzuzufügen. Es ist alles in der API-Dokumentation.

Die Dienstprogrammbibliothek ist ein zusätzlicher Code, den Entwickler in ihre Android-Apps aufnehmen können. Es enthält eine Reihe nützlicher Funktionen, die die Basis-API erweitern. Eines dieser Merkmale ist "marker clustering". Die vollständige Liste der Features befindet sich in der Dokumentation der Dienstprogrammbibliothek.

Der Beispielcode veranschaulicht das Markierer-Cluster-Dienstprogramm in der Dienstprogrammbibliothek von Chris. Bevor Sie also in den Code eintauchen, fragen Sie:

Nehmen wir an, Sie haben eine Karte mit einer großen Anzahl von Markern. (In der Regel ist eine Markierung in einer Google Map eine dieser orangefarbenen spitzen Tröpfchen, die einen Ort auf der Karte markiert.) Wenn Sie alle Markierungen gleichzeitig und einzeln anzeigen, sieht die Karte hässlich aus und ist schwer zu knacken, besonders bei der Karte ist herausgezoomt und viele Marker sind in einem kleinen Bereich konzentriert. Eine Lösung besteht darin, benachbarte Marker zu einem einzigen Markersymbol (einem "Cluster") zusammenzufassen und sie dann in einzelne Markersymbole aufzuteilen, wenn der Benutzer zoomt oder auf das Cluster-Symbol klickt. Das ist das, was Chris's Marker Clustering Utility macht.

Wie sieht das Marker-Clustering aus? Sehen Sie sich die Screenshots in der Dokumentation an.

Entwickler können die von Chris erstellten Klassen implementieren und Aussehen und Verhalten der Cluster anpassen. Die Dienstprogrammbibliothek enthält auch eine Demo-App, die Beispielimplementierungen der Dienstprogramme enthält.

Der beste Weg, eine Codebibliothek zu beschreiben, ist die Bereitstellung von Beispielcode. Basierend auf der Demo-App habe ich ein einfaches Beispiel für ein Marker-Clustering erstellt. Sehen Sie sich den Beispielcode im Dokumentationsabschnitt zum Hinzufügen eines einfachen Marker-Clusterers an.

Vergleichen Sie es jetzt mit dem Code in der Demo-App, die Teil der Dienstprogrammbibliothek ist: ClusteringDemoActivity.java

Die Unterschiede, auf den Punkt gebracht:

  • Der Beispielcode zeigt keine der "plumbing" wie die Bibliothek importieren Anweisungen.
  • Der Beispielcode enthält eine Auflistung der primären Methode, die das Clustering durchführt ("setUpClusterer ()" genannt) und einer Klasse, die für Entwickler wichtig ist ("public class MyItem implementiert ClusterItem").
  • Anstatt eine Eingabe aus einer Datei zu lesen, enthält der Beispielcode eine Methode namens "addItems ()", um einige Beispieldaten direkt aus dem Code zu erstellen.
  • Ich habe dem Beispielcode zahlreiche Kommentare hinzugefügt, in denen die Bits erläutert werden, die für das Marker-Clustering oder das Beispiel selbst spezifisch sind.

Zusammengefasst stellt der Beispielcode alle Entwickleranforderungen bereit, um einen einfachen Marker-Clusterer zum Arbeiten zu bringen, indem der Code einfach in ein vorhandenes Android-Projekt kopiert und eingefügt wird.

Beim Schreiben des Beispielcodes fiel mir ein Gedanke auf:

Hey, es ist eigentlich ein ziemlich interessanter Prozess, der Beispielcode schreibt. Ich werde bloggen, was ich hier mache, und sehen, was andere technische Autoren dazu sagen.

Zuerst ein Stich, um die Ziele für den Beispielcode zu definieren:

  • Bringen Sie den Entwickler so schnell wie möglich zum Laufen.
  • Zum Kopieren und Einfügen geeignet sein.
  • Arbeiten (tun, was es tun soll), wenn es in ein Entwicklungsprojekt fällt.
  • Sei so einfach wie möglich.
  • Stellen Sie Informationen bereit, die beim Lesen des Codes nicht leicht zu finden sind.
  • Illustrieren Sie den primären, grundlegenden Anwendungsfall der API oder des Tools.

Und hier sind meine Notizen darüber, wie man ein nützliches Codebeispiel erstellt:

  • Finden Sie heraus, was der primäre und einfachste Anwendungsfall ist. Das sollte dein Code verdeutlichen. Sprechen Sie mit den Ingenieuren und Produktmanagern, lesen Sie die Anforderungen oder das Design-Dokument, lesen Sie die Code-Kommentare.
  • Finden Sie heraus, was Sie von Ihrem Publikum erwarten können. Können Sie annehmen, dass sie mit der Technologie vertraut sind, mit der Sie arbeiten (in meinem Fall Java und Android)? Weißt du, welche Entwicklungswerkzeuge sie verwenden?
  • Suchen Sie nach "echtem" Code, der etwas Ähnliches leistet. Vielleicht eine ähnliche Funktion oder eine funktionierende Implementierung, die für Ihre Anforderungen zu komplex ist.
  • Vereinfachen Sie es. Machen Sie Namen sinnvoller. Entfernen Sie Funktionen, die für Ihre Umgebung einzigartig sind oder die super-überflüssige, aber überflüssige Funktionen hinzufügen. Entfernen Sie Rohrleitungen wie Import-Anweisungen und alle außer der wesentlichen Fehlerbehandlung.
  • Setzen Sie Ihr Framework ein und testen Sie es. Der Rahmen sollte einer sein, den Ihre Zielgruppe verwenden wird. In meinem Fall ist das ein Android-Entwicklungsprojekt.
  • Machen Sie Screenshots des Codes in Aktion. Sie sind oft nützlich, um den Leuten eine Vorstellung von dem Ziel des Beispielcodes und davon zu geben, was die API oder das Tool tun können.
  • Lassen Sie den Code überprüfen.
  • Fügen Sie es in das Dokument ein.
  • Wenn möglich, fügen Sie den Code in ein Quell-Repository ein und verbinden Sie ihn mit einigen automatisierten Tests, um sicherzustellen, dass er aktuell bleibt.
  • So weit wie möglich, haben Sie alle notwendigen Code in einem Stück, so dass Menschen leicht kopieren und einfügen können. Dies kann bedeuten, dass man sich herumtreibt.
  • Füge Code-Kommentare hinzu. Ingenieure fügen dem Code häufig technische Kommentare hinzu, enthalten jedoch keine Einführung oder einen konzeptionellen Überblick über die Vorgänge. Und unsere Zielgruppe, Entwickler, liest häufig Code-Kommentare, in denen sie keine anderen Dokumente lesen. Codekommentare sind also ein großartiges Medium für die technische Kommunikation!

Vielleicht ist es das Wichtigste, sich selbst als Verfechter oder Vertreter dieser Entwickler zu sehen, die die API oder das Tool verwenden müssen, das Sie veranschaulichen. Überlegen Sie, welche Fragen sie stellen würden, wenn sie Zugriff auf die Personen und Werkzeuge hätten, die Sie verwenden, und geben Sie die Antworten in die Dokumentation und den Beispielcode ein.

Um diese Aufgabe zu erfüllen, benötigen Tech-Autoren ein gewisses Maß an Programmierkenntnissen und auch ein gutes Verständnis dafür, was ein Entwickler für den Einstieg benötigt. Der Beispielcode bietet ein Sprungbrett zwischen den konzeptionellen Übersichten und den komplexen Implementierungen.

Nun, das ist alles, woran ich denken kann. Was habe ich vergessen?

wie man Anweisungen schreibt - 有道 词典

Wie schreibe ich klare Anweisungen (Mit Bildern) - wikiHow

Wie man Schreiben klar Anleitung. . Zum Beispiel, wenn du bist Schreiben Anleitung wie man ein Sandwich mit Erdnussbutter und Marmelade herstellt,.

Wie man Anweisungen schreibt (Mit Bildern) - wikiHow

Wie man Schreibe Anweisungen. Eine Menge von Anleitung sollte einem Leser helfen, eine Aufgabe schnell, effizient und erfolgreich zu erledigen. Es ist wichtig, jedes Detail anzugeben.

Anweisung Probe Buchstaben | Wie schreibt man ein Anweisung .

Anweisungsbeispiel Briefe. Wie man Schreiben ein Anweisung E-Mail Wie geht es? Schreiben ein Anweisung E-Mail-Geschäft E-Mail Anweisung. Wie man Schreiben ein Anweisung Brief

Anweisungsschreiben - Beispiele für Anweisungen durch .

Ich habe diese benutzt Beispiele von Anleitung wenn man einen Alphabetisierungsblock mit Schwerpunkt auf Anweisungsschreiben.

Professionelles und technisches Schreiben / Anweisungen .

Professionell und technisch Schreiben / Anweisungen. . Zum Beispiel, wenn du bist Schreibanweisungen für eine Gruppe von Senioren in der lokalen Öffentlichkeit.

7 Tipps zum Verfassen einer effektiven Bedienungsanleitung - SitePoint

7 Tipps für Schreiben eine effektive Anweisung Handbuch. . und das ist eine Primzahl Beispiel warum zu können schreiben . Wenn du anfängst dich vorzubereiten Anleitung zum .

Technisch Schreiben - Anleitung

Anleitung. Anleitung sind eine Schritt-für-Schritt-Erklärung, wie etwas zu tun ist; Sie machen schwierige Aufgaben leichter verständlich. Es mag so aussehen Schreiben .

Anleitung: Wie man Anleitungen für beschäftigte, mürrische Leute schreibt .

Jerz > Schreiben > Technisch & Professionel > Menschen hassen Lesen Anleitung, und werden nur auf sie schauen, wenn sie hoffnungslos verloren sind. Bis dahin werden sie es schon tun.

Online Technical Writing: Anleitung

Die Zuweisung für diese Einheit konzentriert sich auch auf Beschreibung, Definition oder eine der anderen Informationsstrukturen, die in Anhang F diskutiert werden. Dies sind gemeinsame Elemente in technischem Schreiben. Sie sind nicht nur ein eigener Dokumententyp, sondern erscheinen häufiger als Elemente oder Teile anderer Dokumente, wie zum Beispiel Anweisungen in diesem Fall. Sie können sich jedoch eine Beschreibung vorstellen, die zum Beispiel in Berichten über Unfälle, Grundstücksbewertungen und Produktspezifikationen verwendet wird. Die Vorschläge zu Inhalt, Organisation und Format, die im Abschnitt Informationsstrukturen erläutert werden, geben Ihnen eine gute Grundlage, um diese anderen Arten von Dokumenten zu schreiben.

In der Zuweisung für dieses Kapitel schreiben Sie tatsächlich zwei Zuweisungen in eine: eine Reihe von Anweisungen und eine Informationsstruktur (wie Beschreibung, Definition oder andere), die in diese Anweisungen integriert sind. Dieses Szenario gibt Ihnen Erfahrung mit zwei Schlüsseltypen des technischen Schreibens, aber auf eine Weise, die zwei bis drei Wochen im Semester spart. Dadurch haben Sie gegen Ende des Semesters mehr Zeit, um in Ihrem technischen Berichtsprojekt Vollzeit zu arbeiten.

Beachten Sie die Beispielanweisungen in diesem Kapitel:

Hinweis: Studenten, die an Online Technical Writing teilnehmen, werden ermutigt, das optionale Lesequiz zu diesem Kapitel zu belegen. (Jeder andere ist es auch möglich, es zu versuchen.)

Letztendlich erfordert gutes Schreiben von Anweisungen nicht nur diese Techniken, sondern auch:

  • Klares, einfaches Schreiben
  • Ein gründliches Verständnis des Verfahrens in all seinen technischen Details
  • Ihre Fähigkeit, sich an die Stelle des Lesers zu stellen, der Person, die versucht, Ihre Anweisungen zu verwenden
  • Ihre Fähigkeit, das Verfahren sehr detailliert zu visualisieren und dieses Bewusstsein auf Papier festzuhalten
  • Schließlich, Ihre Bereitschaft, diese zusätzliche Distanz zu gehen und Ihre Anweisungen auf die Art von Person zu testen, für die Sie sie geschrieben haben.

Inzwischen haben Sie wahrscheinlich Überschriften, Listen und spezielle Hinweise studiert - das Schreiben einer Reihe von Anweisungen mit diesen Tools scheint wahrscheinlich offensichtlich. Brich einfach die Diskussion in nummerierte vertikale Listen und schmeiße einige spezielle Hinweise an den offensichtlichen Punkten und du bist fertig! Nun, nicht ganz, aber das ist ein guter Anfang. Diese Einheit untersucht einige der Funktionen von Anweisungen, die sie komplexer machen können. Sie können diese Überlegungen verwenden, um Ihre eigenen Anweisungen zu planen.

Publikum und Situation. Definieren Sie zu Beginn des Prozesses die Zielgruppe und die Situation Ihrer Anweisungen. Denken Sie daran, dass das Definieren eines Publikums die Definition des Grades der Vertrautheit mit dem Thema sowie anderer solcher Details bedeutet. In Anhang A finden Sie eine Erläuterung der Zielgruppe und der Schritte zum Definieren von Zielgruppen.

Am wichtigsten ist, dass Sie Ihr Publikum auf einem separaten Blatt Papier beschreiben und es Ihren Anweisungen entsprechend einreichen müssen. Dies ermöglicht es Ihrem Lehrer, Ihre Anweisungen in Bezug auf ihre Richtigkeit für die beabsichtigte Zielgruppe zu bewerten. Und denken Sie auch daran, dass es in diesem technischen Schreibkurs vorzuziehen ist, für Nicht-Fachpublikum zu schreiben - dies ist für Sie als Autor eine größere Herausforderung.

Anzahl der Aufgaben Eine wichtige Überlegung ist, wie viele Aufgaben in der Prozedur enthalten sind, für die Sie Anweisungen schreiben. Lassen Sie uns den Begriff verwenden Verfahren sich auf die Gesamtheit der Aktivitäten beziehen, die Sie mit Ihren Anweisungen besprechen möchten. EIN Aufgabe ist eine semi-unabhängige Gruppe von Aktionen innerhalb des Verfahrens: Zum Beispiel ist das Einstellen der Uhr auf einem Mikrowellenofen eine Aufgabe in der großen Gesamtprozedur des Betriebs eines Mikrowellenofens.

Ein einfaches Verfahren wie das Wechseln des Öls in einem Auto enthält nur eine Aufgabe; Es gibt keine halb-unabhängigen Gruppierungen von Aktivitäten. Ein komplexeres Verfahren wie die Verwendung eines Mikrowellenofens enthält viele solcher halb-unabhängigen Aufgaben: Einstellen der Uhr; Einstellen der Leistungsstufe; Verwenden des Timers; Reinigung und Wartung der Mikrowelle, unter anderem. (Die Anweisungen zur Verwendung einer Kamera sind nach Aufgaben geordnet.)

Einige Anweisungen haben nur eine Aufgabe, aber viele Schritte innerhalb dieser einzelnen Aufgabe. Stellen Sie sich zum Beispiel eine Reihe von Anweisungen vor, um eine Kinderschaukel zu montieren. Nach meiner eigenen 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 in jeder neuen Phase neu zu nummerieren. EIN Phase dann ist eine Gruppe ähnlicher Schritte innerhalb einer Einzelaufgabenprozedur. Im Beispiel mit dem Swing-Set wäre das Einrichten des Frames eine Phase; das Ding im Boden zu verankern wäre ein anderer; das Zusammenbauen des Kastenschwingens wäre noch ein anderer. (Die Anweisungen zum Installieren eines Wandschranks, beginnend auf der Seite, sind nach Phasen geordnet.)

Bester Ansatz für die schrittweise Diskussion. Eine andere Überlegung, die Sie vielleicht nicht früh genug bestimmen können, ist, wie Sie Ihre Anweisungen fokussieren können. Bei den meisten Anweisungen können Sie sich auf Aufgaben konzentrieren, oder Sie können sich auf Werkzeuge (oder Funktionen von Werkzeugen) konzentrieren.

In einem Aufgabenansatz Anweisungen zur Verwendung eines Anrufbeantworters enthalten Abschnitte zum Aufnehmen Ihrer Begrüßung, Wiedergeben Ihrer Nachrichten, Speichern Ihrer Nachrichten, Weiterleiten Ihrer Nachrichten und Löschen Ihrer Nachrichten. Das sind Aufgaben - die typischen Dinge, die wir mit der Maschine machen wollen.

Auf der anderen Seite, in a Werkzeugansatz Zu den Anweisungen zur Verwendung eines Fotokopierers gibt es Abschnitte auf der Kopierschaltfläche, der Abbruchschaltfläche, der Vergrößerungs- / Verkleinerungsschaltfläche, der Sortier- / Heftetaste, der Papierablage, der Kopierformatschaltfläche und so weiter. Wenn Sie eine Reihe von Anweisungen zu diesem Plan erstellt haben, würden Sie Schritte für die Verwendung der einzelnen Schaltflächen oder Funktionen des Fotokopierers schreiben. Anweisungen, die diesen Werkzeugansatz verwenden, sind schwer zu handhaben. Manchmal entspricht der Name der Schaltfläche nicht genau der Aufgabe, mit der er verknüpft ist. Manchmal müssen Sie mehr als nur die eine Schaltfläche verwenden, um die Aufgabe zu erfüllen. Dennoch kann es Zeiten geben, in denen der Werkzeug / Merkmal-Ansatz vorzuziehen ist.

Gruppierungen von Aufgaben. Das Auflisten 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 die einzelnen leichter finden können. Zum Beispiel sind die folgenden allgemeinen Aufgabengruppierungen in Anweisungen: Entpacken und Setup-Aufgaben; Installation und Anpassung von Aufgaben; grundlegende Betriebsaufgaben; Routinewartungsaufgaben; Fehlersuche Aufgaben; und so weiter. (Für den Zweck dieses technischen Schreibkurses müssen Sie nicht alle diese Möglichkeiten abdecken - aber in einer realen Welt von Anweisungen würden Sie das tun.)

Gemeinsame Abschnitte in Anweisungen

Wenn Sie die folgenden Abschnitte in Anweisungen lesen, lesen Sie die Beispielanweisungen auf der Seite. Nicht alle der folgenden Abschnitte, die normalerweise in Anweisungen gefunden werden, werden in den Beispielen angezeigt, die meisten jedoch.

Abbildung 8-1. Schematische Ansicht der Anweisungen. Denken Sie daran, dass dies ein typisches oder gemeinsames Modell für den Inhalt und die Organisation ist - viele andere sind möglich.

Einführung. Planen Sie die Einführung Ihrer Anweisungen sorgfältig. Stellen Sie sicher, dass es eine der folgenden (aber nicht unbedingt in dieser Reihenfolge) Schritte ausführt, die für Ihre speziellen Anweisungen gelten:

  • Geben Sie die spezifischen Aufgaben oder das Verfahren an, die erläutert werden sollen, sowie den Umfang der Berichterstattung (was? Gewohnheit Versteckt sein).
  • Geben Sie an, was die Zielgruppe in Bezug auf Wissen und Hintergrund benötigt, um die Anweisungen zu verstehen.
  • Geben Sie einen Überblick über das Verfahren und was es bewirkt.
  • Geben Sie die Bedingungen an, zu denen diese Anweisungen verwendet werden sollten (oder nicht sollten).
  • Geben Sie einen Überblick über den Inhalt der Anweisungen.

Nun erinnere dich: Du brauchst vielleicht nicht alle diese Elemente, und einige von ihnen können ordentlich zu einzelnen Sätzen kombiniert werden. Die Einführung sollte lebhaft und sachlich sein und nicht das Gefühl haben, mühsam durch jedes dieser Elemente zu stapfen. (Weitere Informationen finden Sie in Kapitel 10 zu Einführungen.

Allgemeine Warnung, Vorsicht, Gefahrenhinweise. Anweisungen müssen den Leser oft auf die Möglichkeit aufmerksam machen, seine Ausrüstung zu ruinieren, die Prozedur zu schaden und sich selbst zu verletzen. Außerdem müssen Instruktionen häufig wichtige Punkte oder Ausnahmen hervorheben. Für diese Situationen verwenden Sie spezielle Hinweise - Hinweis-, Warn-, Vorsichts- und Gefahrenhinweise, die in Kapitel 6 behandelt werden. Beachten Sie, wie diese speziellen Hinweise in den Beispielanweisungen am Ende dieses Kapitels verwendet werden.

Technischer Hintergrund oder Theorie. Zu Beginn bestimmter Arten von Anweisungen (natürlich nach der Einführung) benötigen Sie möglicherweise eine Diskussion über den Hintergrund des Verfahrens. Für bestimmte Instruktionen ist dieser Hintergrund kritisch - ansonsten machen die Schritte in der Prozedur keinen Sinn. Zum Beispiel haben Sie vielleicht etwas Erfahrung mit solchen Software-Applets gemacht, in denen Sie Ihre eigenen Farben definieren, indem Sie rote, grüne und blaue Schieberegler anstoßen. Um wirklich zu verstehen, was Sie tun, müssen Sie etwas Hintergrundwissen über Farbe haben. Ähnlich können Sie sich vorstellen, dass für bestimmte Anweisungen, die Kameras verwenden, auch eine Theorie benötigt wird.

Ausrüstung und Versorgung. Beachten Sie, dass die meisten Anweisungen eine Liste der Dinge enthalten, die Sie sammeln müssen, bevor Sie die Prozedur starten. Das beinhaltet Ausrüstung, die Werkzeuge, die Sie in dem Verfahren verwenden (wie Mischen von Schüsseln, Löffeln, Bratpfannen, Hämmern, Bohrern und Sägen) und Lieferungen, die Dinge, die in dem Verfahren verbraucht werden (wie Holz, Farbe, Öl, Mehl und Nägel). In Anweisungen werden diese normalerweise entweder in einer einfachen vertikalen Liste oder in einer zweispaltigen Liste aufgeführt. Verwenden Sie die zweispaltige Liste, wenn Sie einigen oder allen Artikeln Spezifikationen hinzufügen müssen, z. B. Markennamen, Größen, Mengen, Typen, Modellnummern und so weiter.

Diskussion der Schritte. Wenn Sie mit dem eigentlichen Schreiben der Schritte beginnen, müssen Sie Folgendes beachten: (1) die Struktur und das Format dieser Schritte, (2) zusätzliche Informationen, die möglicherweise benötigt werden, und (3) die Sichtweise und allgemeiner Schreibstil.

Struktur und Format. Normalerweise stellen wir uns eine Reihe von Anweisungen vor, die als vertikale nummerierte Listen formatiert sind. Und die meisten sind tatsächlich. Normalerweise formatieren Sie Ihre tatsächlichen Schritt-für-Schritt-Anweisungen 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. Zum Beispiel, wenn Sie das Öl in einem Auto ändern, ist das Ablassen des Öls ein Schritt, der Muss Komm bevor du das neue Öl gibst. Dies sind nummerierte Listen (normalerweise vertikale nummerierte Listen).
  • Stufen variabler Reihenfolge sind Schritte, die praktisch in beliebiger Reihenfolge ausgeführt werden können. Gute Beispiele sind die Fehlerbehebungsleitfäden, in denen Sie aufgefordert werden, dies zu überprüfen und zu überprüfen, wo Sie etwas reparieren möchten. Sie können diese Art von Schritten praktisch in beliebiger Reihenfolge ausführen. Bei diesem Typ ist die Aufzählungsliste das geeignete Format.
  • Alternative Schritte sind diejenigen, in denen zwei oder mehr Möglichkeiten, dasselbe zu erreichen, dargestellt werden. Alternative Schritte werden auch verwendet, wenn verschiedene Bedingungen vorliegen. Verwenden Sie Listen mit Aufzählungszeichen mit diesem Typ, wobei OR zwischen die Alternativen eingefügt wird oder dass der Einstieg angibt, dass Alternativen angezeigt werden sollen.
  • Verschachtelte Schritte. In einigen Fällen können einzelne Schritte innerhalb einer Prozedur sehr komplex sein und müssen in Teilschritte unterteilt werden. In diesem Fall ziehen Sie die Unterschritte weiter ein und sortieren sie als a, b, c usw. ab.
  • "Stufenlos9quot; Anleitung. Und schließlich gibt es Anweisungen, die die nummerierte vertikale Liste wirklich nicht verwenden können und die, wenn überhaupt, eine geradlinige Anweisungsstilführung des Lesers tun. Einige Situationen müssen so verallgemeinert oder so variabel sein, dass Schritte nicht angegeben werden können. (Lassen Sie uns diese Möglichkeit für diese Aufgabe jedoch ignorieren.)

(Siehe Kapitel 5 in Listen für den Stil und das Format dieser Möglichkeiten.)

Ergänzende Diskussion. Oft reicht es nicht aus, den Lesern einfach zu sagen, dies zu tun oder zu tun. Sie benötigen zusätzliche erklärende Informationen wie, wie das Ding vor und nach dem Schritt aussehen sollte; warum sollten sie sich darum kümmern, diesen Schritt zu machen; Welches mechanische Prinzip steckt hinter dem, was sie tun? noch mehr Mikroebene Erklärung des Schrittes - Diskussion der spezifischen Aktionen, die den Schritt ausmachen.

Das Problem bei ergänzender Diskussion ist jedoch, dass es den eigentlichen Schritt verbergen kann. Sie wollen, dass der eigentliche Schritt - die spezifischen Aktionen, die der Leser machen soll - hervorsticht. Du willst nicht, dass alles in einem Haufen von Wörtern vergraben ist. Es gibt mindestens Techniken, um dieses Problem zu vermeiden: Sie können die Anweisung aus der Ergänzung in separate Absätze aufteilen; oder Sie können die Anweisung fett formatieren.

Schreibstil. Die Art und Weise, wie Sie Anweisungen, Satz für Satz, tatsächlich schreiben, mag widersprüchlich zu dem sein, was Ihnen die vorangegangenen Schreibkurse beigebracht haben. Beachten Sie jedoch wie "real-world9quot; Anweisungen werden geschrieben - sie benutzen eine Menge imperativer (Befehl oder direkte Adresse) Arten des Schreibens; Sie verwenden eine Menge von "du.9 "; Das ist völlig angemessen. Sie wollen in das Gesicht Ihres Lesers eindringen, ihn oder seine volle Aufmerksamkeit bekommen. Aus diesem Grund klingen Sätze im Anweisungsstil folgendermaßen: "Drücken Sie nun die Pause-Taste an der Vorderseite, um die Anzeige vorübergehend zu stoppen" und "Sie sollten vorsichtig sein, nicht zu. "

Ein besonderes Problem beinhaltet die Verwendung der passiven Stimme in Anweisungen. Aus irgendeinem seltsamen Grund klingen einige Anweisungen so: "Die Pause-Taste sollte gedrückt werden, um die Anzeige vorübergehend zu stoppen." Wir sorgen uns nicht nur um die psychische Gesundheit des Pausenknopfes, sondern wir fragen uns auch, wer das Ding drücken soll (sprichst du mit mir?). Oder betrachten Sie dieses Beispiel: "Die Timer-Taste ist dann auf 3:00 eingestellt." Wiederum als die Person, die diesen Anweisungen folgt, könntest du dies vermissen; Sie könnten denken, dass es sich lediglich um einen Bezug auf einen bestehenden Staat handelt, oder Sie fragen sich vielleicht, "Sprechen sie mit mir?" Fast so schlimm ist die dritte Person: "Der Benutzer sollte dann die Pause-Taste drücken." Wieder ist es das alte Doppel-Take: du schaust dich im Raum um und fragst dich, "Wer ich?" (Weitere Details zum Passiv-Voice-Problem finden Sie in Anhang E.)

Ein anderes typisches Problem mit dem Schreibstil in Anweisungen ist, dass die Leute scheinbar Artikel weglassen wollen: "Drücken Sie die Pause-Taste an der Vorderseite, um die Anzeige von Informationen vorübergehend zu stoppen" oder "Eartperson, geben Sie bitte die Adresse des nächsten Pizzarestaurants an." Warum machen wir das? Wollen wir alle heimlich Roboter sein? Achten Sie darauf, alle Artikel (ein, ein, das) und andere solche Wörter, die wir normalerweise in Anweisungen verwenden würden.

Diese Schreibaufgabe fordert Sie auf, Illustrationen oder andere Arten von Grafiken einzufügen - was auch immer in den Anweisungen verwendet wird. Das Problem kann natürlich sein, dass Sie keinen Zugang zu Grafiken haben, die für Ihre speziellen Anweisungen geeignet sind, und dass Sie sich in Ihren künstlerischen Fähigkeiten nicht allzu sicher fühlen. Es gibt Möglichkeiten, diese Probleme zu überwinden! Sehen Sie sich die Vorschläge in Kapitel 7 an. In diesem Kapitel finden Sie nicht nur Vorschläge zum Erstellen von Grafiken, sondern auch Anforderungen an ihr Format.

Listen. In ähnlicher Weise verwenden Befehle typischerweise Listen, insbesondere nummerierte vertikale Listen, für die eigentlichen Schritt-für-Schritt-Erklärungen. Einfache vertikale Listen oder zweispaltige Listen sind normalerweise gut für den Ausrüstungs- und Versorgungsabschnitt. In-Satz-Listen sind gut, wenn Sie einen Überblick über zukünftige Dinge geben. Anforderungen an Listen finden Sie in Kapitel 5 (denken Sie daran, dass Sie in diesem Kurs aufgefordert werden, den Stil und das Format für die dort beschriebenen Listen zu verwenden).

Besondere Hinweise. In den Anweisungen müssen Sie die Leser auf Möglichkeiten aufmerksam machen, in denen sie ihre Ausrüstung, Abfallversorgung beschädigen können, das ganze Verfahren zum Scheitern bringen kann, sich selbst oder andere verletzen - sogar ernst oder tödlich. Unternehmen wurden wegen Fehlens dieser besonderen Hinweise, wegen schlecht geschriebener Sondermitteilungen oder aufgrund von Sondermitteilungen, die fehl am Platz waren, verklagt. In Kapitel 6 finden Sie eine vollständige Erörterung über die ordnungsgemäße Verwendung dieser speziellen Hinweise sowie deren Format und Platzierung in den Anweisungen. (Auch in diesem Kurs haben wir den Stil und das Format für diese Hinweise, die in diesem Kapitel beschrieben werden).

Nummer, Abkürzungen und Symbole. Anweisungen verwenden auch viele Zahlen, Abkürzungen und Symbole. Richtlinien hierzu finden Sie in Anhang D.

Willkommen bei der größten Online-Sammlung von Artikeln, Aufsätzen, Briefen, Berichten, Vorschlägen und Rezensionen für die CPE und CAE Cambridge Englischprüfungen. Lehrer und Studenten aus der ganzen Welt sind eingeladen, sich zu beteiligen, indem sie ihre Schriften einreichen. Wir bieten im Moment einen KOSTENLOSEN Bearbeitungsservice und / oder Korrekturservice an.

1. Bevor du schreibst

Sagen Sie: "Ich bin in Geschichtsprogramme und ich mag auch Musik-TV-Shows."

Stellen Sie sich die folgenden Fragen:

- Habe ich die Aufgabe erledigt? (Inhalt)

- Ist mein Artikel gut organisiert? (Organisation)

- Habe ich ein breites Vokabular verwendet? (Sprache)

- Habe ich verschiedene Grammatikformen verwendet? (Sprache)

- Ist der Artikel im selben Stil geschrieben? (Stil)

- Ist der Artikel interessant genug? (Leser)

Häufig gestellte Fragen:

Es kommt auf die internationale Prüfung an. Bei CPE zum Beispiel liegt es zwischen 250-350. Es ist wichtig, die Anweisungen sorgfältig zu lesen, die erwartete Anzahl der Wörter muss da sein.

Wie ich es sehe, ist ein Essay akademischer, normalerweise für eine Universität / College-Klasse geschrieben. Ein Artikel ist normalerweise für eine Zeitschrift oder einen Blog, sie kann formell oder informell sein, die Themen können ernst oder trivial sein, sie sollen informieren und auch unterhalten.

Professionelles und technisches Schreiben / Anweisungen

Viele Menschen sind es gewohnt, schriftlichen Anweisungen zu folgen, aber die meisten Menschen haben nie Anweisungen für eine andere Person geschrieben. In vielen professionellen Rollen müssen Sie möglicherweise Anweisungen schreiben. Während einige Anweisungen einfach und kurz sind, können andere Anweisungen komplexer sein und länger dauern. Aus diesem Grund ist es wichtig zu wissen, wie man nützliche Anweisungen schreibt.

Das Schreiben nützlicher Anweisungen kann schwierig sein, weil die Leute die Dinge anders lesen und verstehen. Zum Beispiel sind einige Menschen visuelle Lernende und haben möglicherweise Schwierigkeiten, schriftlichen Anweisungen zu folgen. Leser haben auch eine Vielzahl von pädagogischen Hintergründen. Beim Schreiben von Anweisungen ist es wichtig, einen einfachen, logischen Stil und ein Format zu verwenden.

Vermeiden Sie beim Schreiben von Anweisungen persuasive Sprache und nehmen Sie einen aufgabenbasierten Ansatz vor. Halten Sie das Schreiben übersichtlich und klar und konzentrieren Sie sich darauf, dass der Benutzer die Aufgabe erfolgreich ausführen kann.

Befolgen Sie im Allgemeinen diese Richtlinien:

Prägnanz und Klarheit

Halten Sie Sätze kurz und verständlich. Verwenden Sie nach Möglichkeit eine gemeinsame Terminologie. Vermeiden Sie die Verwendung von Idiomen, Slang, Jargon, Spitznamen, Abkürzungen und Akronymen. Wenn Sie eine Terminologie verwenden, die neu oder verwirrend sein könnte, definieren Sie jeden Begriff eindeutig, wenn er zum ersten Mal in den Anweisungen erscheint.

Es ist wichtig, dass Sie Ihre Zielgruppe kennen, wenn Sie Anweisungen schreiben, sodass Sie alle notwendigen Informationen einbeziehen und unnötige Informationen ausschließen. Wenn Sie Ihre Zielgruppe kennen, können Sie vernünftige und gut informierte Annahmen treffen, die auf dem wahrscheinlichen Hintergrund, der Erfahrung und der Vertrautheit des Publikums mit dem Thema basieren. Wenn Sie beispielsweise Anweisungen für eine Gruppe von Senioren in der lokalen Zweigstelle der öffentlichen Bibliothek schreiben, ist es nicht sicher anzunehmen, dass sie mit den Grundlagen zum Öffnen einer bestimmten Softwareanwendung vertraut sind. Wenn Sie jedoch Anweisungen für eine Gruppe von Softwareentwicklern in einer professionellen Organisation schreiben, kann davon ausgegangen werden, dass sie mit den Grundlagen zum Öffnen einer bestimmten Softwareanwendung vertraut sind.

Bei der Entscheidung, welche Informationen in die Instruktionen aufgenommen und von ihnen ausgeschlossen werden sollen, ist es wichtig, klar zu identifizieren, wer Ihre Zielgruppe ist und welche Fähigkeiten sie wahrscheinlich mit dem Thema der Instruktionen und den zugehörigen Hintergrundinformationen haben.

Wenn ein Publikum wahrscheinlich über eine breite Palette von Erfahrungen und Kenntnissen verfügt, die unterschiedliche Kenntnisse und Fachkenntnisse aufweisen, können Sie verschiedene Methoden verwenden, um die einzelnen Anweisungen präzise und konzentriert auf eine einzelne Aufgabe zu konzentrieren und dennoch die erforderlichen Informationen bereitzustellen. Sie können z. B. separate Anweisungen für vorausgesetzte Informationen erstellen und Ihrer Zielgruppe die Möglichkeit geben, schnell und einfach auf die einzelnen Anweisungen zuzugreifen (über Hyperlinks, Anhänge usw.).

Bilder sagen mehr als Worte. Hinzufügen von Grafiken, um Ihre Gedanken zu vermitteln, kann effektiver sein als die Wörter selbst. Anweisungen, die gut illustriert sind und Ihre schriftlichen Anweisungen begleiten, sind in der Regel sehr erfolgreich. Es fügt eine zusätzliche Ebene des Verständnisses hinzu und erlaubt dem Leser zu überfliegen oder Fehler zu beheben, wenn Probleme auftreten. Bilder fügen eine zusätzliche Dimension hinzu, die es Ihrem Leser ermöglicht, das Endprodukt zu visualisieren. Wenn Sie Grafiken verwenden, sollten Sie diese visuellen Lerner berücksichtigen und die Grafiken anpassen.

Obwohl Bilder groß sind, müssen Sie vorsichtig sein, keine Fotos oder Illustrationen aufzunehmen, die verwirrend oder nicht mit den tatsächlichen schriftlichen Anweisungen verbunden sind. Wenn Sie ein schlechtes Bild mit Ihren Anweisungen kombinieren, können Sie den Leser stressen oder Verwirrung stiften, wenn Sie versuchen zu entschlüsseln, was Sie meinen.

Achten Sie auch beim Fotografieren darauf, dass der Bereich gut ausgeleuchtet ist und die Bilder klar und hell sind. Dunkle oder unscharfe Bilder sind oft schwer zu verfolgen. Achten Sie darauf, das Motiv jedes Mal in der gleichen Ausrichtung zu fotografieren, um Verwechslungen zu vermeiden, und erwägen Sie, ein Stativ zu verwenden.

Die Größe ist auch wichtig, wenn Bilder in Anweisungen verwendet werden. Ein Bild, das zu klein ist, um es zu sehen, ist genauso nutzlos wie ein verschwommenes Bild.

Um wirkungsvoll und verständlich zu sein, sollten Text und Grafik für jeden Schritt eindeutig mit diesem Schritt der Anleitung übereinstimmen.

Denken Sie daran, dass die Leser die Aufgabe tatsächlich ausführen werden, wenn sie die Anweisungen lesen. Sie sollten also keine festen Blöcke von kleinen, schwer zu entziffernden Texten verwenden. Stellen Sie sicher, dass Sie ein Design und ein Layout für Ihre Instruktionsseite erstellen, das eine einfache Lesbarkeit und ästhetische Qualität bietet. Die Seite einfach zu halten, aber mit einer definierten Hierarchie, wird dem Leser helfen, die Schritte der Anweisungen zu vervollständigen.

Bei der Gestaltung Ihrer Seite ist eine solide Hierarchie wichtig für die Scan-Fähigkeit. Die Verwendung von fettgedruckten Überschriften, Kursivschrift und römischen Ziffern hilft dem Leser, ihren Platz leicht zu finden und hilft bei der allgemeinen visuellen Erscheinung.

Es ist wichtig, dass Ihre Anweisungen in einer logischen Folge geplant werden. Stellen Sie sicher, dass das Problem auf der ersten Seite deutlich angegeben ist. Folgen Sie Ihren Problemen mit einer Reihe von spezifischen Schritten, die detailliert beschreiben, wie das vorgeschlagene Problem zu lösen ist. Technische Anweisungen müssen in einem logischen Muster fließen. Zum Beispiel, wenn Sie einen Tisch zusammenbauen, wäre es nicht gut, wenn Sie den letzten Schliff machen, bevor Sie alle Schrauben an Ort und Stelle haben. Wie bereits erwähnt, sollte es auch klare Grafiken geben, wenn dies zur Klärung der Handlung erforderlich ist. Denken Sie daran, ein Bild sagt mehr als tausend Worte.

Testen und Verifizieren

Wir alle wissen, dass Anweisungen schwer zu schreiben sind und dass es manchmal auf dem Papier gut klingt, aber wenn Sie tatsächlich versuchen, die Anweisungen zu verwenden, könnten Sie feststellen, dass Ihre Formulierung für andere keinen Sinn ergibt. Denken Sie daran, was für Sie vielleicht üblich oder offensichtlich ist, Ihre Leser verblüffen können, also kennen Sie Ihr Publikum. Testen Sie Ihre Anweisungen nicht nur selbst, sondern lassen Sie auch jemanden kennen, der nichts über Ihr Produkt weiß. Dies wird als Usability-Studie bezeichnet. Machen Sie sich Notizen darüber, was funktioniert hat und was nicht und korrigieren Sie Ihre Anweisungen entsprechend. Auf lange Sicht, je mehr Leute Ihre Anweisungen testen, desto effektiver wird der endgültige Satz sein.

Das Anpassen Ihrer Anweisungen an die Zielgruppe kann eine der schwierigsten Aufgaben Ihres Schreibprozesses sein. Bevor Sie mit Ihrem Schreibprozess beginnen, müssen Sie herausfinden, wer Ihre Zielgruppe sein wird und wie Sie Ihre Anweisungen so anpassen können, dass sie so verständlich wie möglich sind. Um Ihnen dabei zu helfen, können Sie sich einige Fragen stellen:

  • Welchen Hintergrund haben Ihre Zuschauer und welche Vorkenntnisse haben sie? Dies wird Ihnen helfen zu bestimmen, was Sie Ihren Anweisungen hinzufügen oder nicht hinzufügen müssen.
  • Was werden ihre Bedürfnisse / Interessen sein?
  • Wie beeinflussen ihre demografischen Daten Ihre Schreibweise? Wenn die Mehrheit Ihrer Zielgruppe aus einer anderen Bevölkerungsgruppe stammt als Sie, müssen Sie Sprachprobleme berücksichtigen und sicherstellen, dass die Grafiken klar sind.
  • Gibt es eine Variabilität in Ihrem Publikum? Wenn Ihre Zielgruppen aus Personen mit unterschiedlichen Hintergründen bestehen, sollte Ihr Schreiben auf die Mehrheit Ihrer Zielgruppe zugeschnitten sein, und Sie können auch zusätzliche Informationen in Anhängen hinzufügen.

Basierend auf Ihren Antworten auf die oben genannten Fragen gibt es mehrere Möglichkeiten, wie Sie sicherstellen können, dass Ihre Anweisungen für Ihre Leser so klar wie möglich sind.

  • Fügen Sie Informationen hinzu (z. B. Tipps, Notizen), die die Leser benötigen, um Ihre Anweisungen zu verstehen und sicherzustellen, dass keine Schlüsselinformationen fehlen.
  • Fügen Sie keine unnötigen Informationen hinzu. Es kann Ihre Leser verwirren oder irreführen.
  • Stellen Sie sicher, dass das Dokument auf der Ebene Ihrer Zielgruppe ist.
  • Fügen Sie Beispiele / Grafiken hinzu. Grafiken können für einen Leser sehr hilfreich sein.
  • Eine klare Organisation haben Mangelnde Organisation schafft Verwirrung und Frustration.

Die folgenden Abschnitte beschreiben die verschiedenen Teile der allgemeinen Überstruktur eines Anweisungssatzes. Welche Abschnitte enthalten sind, hängt von der Komplexität der Anweisungen ab. Ihr Dokument kann einen der folgenden Abschnitte enthalten:

  • Einführung
  • Beschreibung der Ausrüstung
  • Notwendige Materialien und Ausrüstung
  • Die Verfahren
  • Visuelle Hilfen
  • Fehlerbehebung

Was in Ihrer Einführung enthalten ist, hängt davon ab, wofür Sie Ihre Anweisungen verwenden und wer sie verwendet. In jedem Fall sollte die Einführung kurz sein, aber immer noch informativ. Die Einführung kann einen oder alle der folgenden Abschnitte enthalten:

  • Gegenstand / Ziel: Hier sollten Sie die spezifische Aufgabe angeben, die erklärt wird und was das Ergebnis des Verfahrens sein wird.
  • Beabsichtigte Leser: Sie möchten vielleicht herausfinden, wer die beabsichtigten Leser der Anweisungen sind und ob der Leser zusätzliches Wissen oder Hintergrund benötigt, um die Aufgabe zu erledigen.
  • Umfang: Dies wird dem Leser helfen, zu wissen, ob die Anweisungen ihnen helfen werden, die Aufgabe zu erfüllen, die sie wollen oder nicht.
  • Organisation: Wenn der Leser einen Überblick darüber erhält, wie die anderen Anweisungen aussehen, kann er ihnen helfen, sie leichter zu verstehen. Dieser Abschnitt könnte auch unter den Geltungsbereich fallen.
  • Sicherheit: Es liegt in Ihrer Verantwortung, die Leser über Gefahren oder Gefahren zu informieren, die bei der Ausführung der Aufgabe auftreten können. Sie müssen die Warnungen klar und verständlich anzeigen.

Wenn es Geräte gibt, die der Leser verwenden muss, um ein Gerät zu bedienen oder zu reparieren, können Sie eine Beschreibung hinzufügen.

Geben Sie eine Liste der Geräte an, die der Leser zum Ausführen der Aufgabe benötigt, damit er weiß, ob er zusätzliche Werkzeuge oder Dinge benötigt, die er normalerweise nicht hat. Eine Liste von Zubehör ist auch hilfreich für einen Leser, um sicherzustellen, dass sie alle Teile und Teile haben, die sie benötigen.

Dieser Abschnitt ist offensichtlich der wichtigste Teil eines Anweisungssatzes, da es die tatsächlichen Schritte sind, denen der Leser folgen wird, um die vorliegende Aufgabe zu vervollständigen. Es gibt viele Möglichkeiten, die Prozeduren zu formatieren, aber die meisten sind mit nummerierten Listen gemacht. Die folgenden Dinge sollten Sie tun, um die Schritte klar und prägnant zu machen:

  • Schreiben Sie jeden Schritt mit präzisen Formulierungen, damit er leicht verständlich und vollständig ist.
    • Techniken:
      • Geben Sie den Lesern genügend Informationen, um den Schritt auszuführen und Redundanz zu vermeiden.
      • Lege die Schritte in eine Liste. Nummerierung funktioniert oft am besten.
      • Schlüsselwörter hervorheben.
  • Stellen Sie sicher, dass der Leser Schritte schnell und einfach finden kann.
    • Techniken:
      • Anzahl Schritte.
      • Überspringen von Zeilen zwischen Schritten.
  • Machen Sie Aktionen, die sich vom Rest des Textes abheben.
  • Sagen Sie dem Leser, was er tun soll, wenn er einen Fehler macht. Nicht zu wissen, was zu tun ist, wird Frustration verursachen und der Leser kann die Aufgabe aufgeben.

Die Verwendung von Grafiken und Bildern für jeden Schritt wird dringend empfohlen. Jede Person hat unterschiedliche Lerngewohnheiten; manche mögen Texte, andere besser mit Bildern. Das Vorhandensein von Grafiken ermöglicht es dem Leser auch, sicherzustellen, dass er / sie immer noch auf der richtigen Spur ist. In den meisten Situationen wäre es vorteilhaft, eine Kombination aus Grafiken und Wörtern zu haben.

Anweisungen sollten diesen Abschnitt enthalten, um dem Leser zu sagen, was zu tun ist, wenn während des Bauprozesses etwas schief geht oder das fertige Projekt nicht wie erwartet aussieht. Diese Informationen in ein Tabellenformat zu bringen, funktioniert oft am besten.

Für einen Beispielsatz von Anweisungen besuchen Sie [1] Diese Webseite enthält Informationen aus dem Lehrbuch mit dem Titel Elektrowerkzeuge für die technische Kommunikation von David A. McMurrey.

Usability-Tests sind ein absolut entscheidender Schritt bei der Erstellung eines effektiven Satzes von Anweisungen. Sobald Sie einen Entwurf Ihrer Anweisungen erstellt haben, ist es wichtig, sie zu testen, um zu sehen, wo Verbesserungen vorgenommen werden können. Für jeden aktualisierten Entwurf Ihrer Anweisungen sollte ein Usability-Test für mehrere Tester durchgeführt werden. Gehen Sie folgendermaßen vor, um einen Usability-Test durchzuführen:

1. Zuerst sollten Sie Ihre Tester aus einer Gruppe auswählen, die repräsentativ für Ihre Zielgruppe ist. Um diese spezifischen Benutzer auszumachen, müssen Sie möglicherweise einige vorläufige Fragen stellen. Zum Beispiel fragen, was ihre Erfahrungsebene mit der Aufgabe ist oder was ihr Jobfeld ist.

2. Als nächstes müssen Sie auswählen, wie Sie die Leistung des Testers beim Ausführen der Aufgabe bewerten möchten. Es gibt verschiedene Methoden zur Auswahl, aber eine Methode heißt "Think Aloud". Wenn Sie diese Methode verwenden, bitten Sie Ihren Tester, die Aufgabe mit Ihren Anweisungen zu erledigen, während Sie alles, was ihnen durch den Kopf geht, verbalisieren. Bieten Sie dem Tester keine Hilfe an, wenn er oder sie den Test besteht, und teilen Sie ihm freundlich mit, dass Sie am Ende seine Fragen beantworten können. Wie der Tester sagt, was verwirrend oder schwer ist, machen Sie sich Notizen. Sie können diese Informationen in einem Diagramm mit drei Spalten aufzeichnen. In der ersten Spalte werden Sie die Probleme Ihres Testers aufzeichnen. In der zweiten Spalte notieren Sie, was die mögliche Ursache für jedes Problem war. Im dritten Versuch, eine mögliche Lösung für das Problem oder mögliche Wege zu generieren, können Sie Ihre Anweisungen ändern, um sie verständlicher zu machen. Seien Sie sicher beschreibend in was Sie herausfinden möchten. Stellen Sie sicher, dass Sie ein Testformular auslegen, um alle relevanten Informationen über Ihre Tests zu sammeln, so dass keine Informationen übersehen oder verlegt werden.

3. Nachdem der Test abgeschlossen ist, sehen Sie sich Ihre Notizen an und bitten Sie den Tester, die von Ihnen notierten Probleme zu erläutern. Dies ist ein wichtiger Schritt, da Sie direktes Feedback von Ihrem Publikum erhalten. Stellen Sie sicher, dass Sie genau verstehen, was für sie verwirrend ist, da dies Ihnen beim Schreiben der erfolgreichsten Anweisungen hilft. Fragen Sie die Tester, wie Sie diesen Schritt oder einen Teil der Anweisungen ändern können, um sie eindeutig zu machen.

4. Bearbeiten und aktualisieren Sie Ihre Anweisungen basierend auf Ihren Ergebnissen. Nachdem Sie dies getan haben, sollten sie verständlicher und einfacher zu verstehen sein. In vielen Fällen ist es angemessen oder sogar notwendig, eine oder mehrere Runden von Usability-Tests durchzuführen, während Sie Ihre Anweisungen perfektionieren. Weitere Tests könnten sich als nützlich erweisen, wenn Probleme entdeckt werden, die in der ersten Testphase übersehen wurden, oder weil die Probleme durch ursprüngliche Komplikationen maskiert wurden. Wenn es die Zeit erlaubt, sollten Sie so viele Usability-Testreihen durchführen, wie Sie benötigen.

  • Hinweis: Achten Sie besonders auf Ihre Zielgruppe und stellen Sie sicher, dass Sie über die Anzahl der Tester und die genauen Demografien verfügen, die für die genaue Darstellung Ihrer Stichprobe erforderlich sind. Wenn Sie beispielsweise Anweisungen für ein "Anfängerpublikum" erstellen und ein "Expertenpublikum" testen, ist Ihre Stichprobe nicht repräsentativ. Wenn Sie außerdem Anweisungen für ein großes Publikum mit mehreren Alters-, Geschlechts- und Erfahrungsstufen erteilen möchten, muss Ihre Stichprobe groß und repräsentativ für diese Bevölkerungsgruppe sein.
  • Wenn die Anweisungen erfordern, dass der Tester beide Hände benutzt (wie zum Beispiel das Binden einer Krawatte), sollten Sie alle Anweisungen sichtbar machen, ohne Seiten umblättern zu müssen, damit es einfacher ist, die Aufgabe zu erledigen.

Viele Menschen widerstehen den Anweisungen zu lesen. Sie versuchen, selbst herauszufinden, wie ein Produkt zu bedienen ist oder eine Aufgabe zu erledigen, und wenden sich nur dann an die Anweisungen, wenn alle Bemühungen scheitern. Wenn sie die Anweisungen lesen, wollen sie alles sofort verstehen, ohne zweimal etwas lesen zu müssen. Ein einfaches Design, klare Formulierungen und klare Anweisungen sind entscheidend, um Leser dazu zu ermutigen, auf Ihre Anweisungen oder Verfahren zu achten.

Beim Schreiben von technischen Dokumenten und Anleitungen gibt es einige Stiltipps, die Sie beachten sollten:

  • Verwenden Sie eine Menge Imperativ, Befehl oder direkte Adresse, Arten des Schreibens. Es ist in Ordnung, "Sie" beim Schreiben von Anweisungen zu verwenden, da Sie den Leser direkt ansprechen.
  • Verwenden Sie aktive anstelle von passiver Stimme.
  • Lassen Sie Artikel wie a, an und the nicht aus.
  • Verwenden Sie Aktionsverben.
  • Stellen Sie sicher, dass Grafiken beschreibenden Text enthalten, um Verwechslungen zu vermeiden
  • Grafiken nach Schritten beschriften, zum Beispiel Schritt 17 ". Put.", Sollte die Grafik deutlich mit einer Zahl "17" beschriftet sein oder wenn mehrere Grafiken für eine Textzeile in chronologischer Reihenfolge "17a, 17b, etc." vorhanden sind oder wenn verschiedene Ansichten "17 vorne, 17 hinten, etc."
  • Halten Sie den Text kurz, aber beschreibend.
  • Vermeiden Sie komplizierte Fachausdrücke, verwenden Sie einfache Ausdrücke, um das Verständnis für ein breites Spektrum von Benutzern sicherzustellen.
  • Verwenden Sie kurze Überschriften und Zwischenüberschriften, um jeden Abschnitt zu beschreiben und hervorzuheben.
  • Lassen Sie viel Leerraum um die Überschriften herum.
  • Markieren Sie Sicherheitsinformationen und Warnungen.
  • Halten Sie Illustrationen so einfach wie möglich.
1 Star2 Stars3 Stars4 Stars5 Stars (Пока оценок нет)
Loading...
Like this post? Please share to your friends:
Leave a Reply

87 − = 86

;-) :| :x :twisted: :smile: :shock: :sad: :roll: :razz: :oops: :o :mrgreen: :lol: :idea: :grin: :evil: :cry: :cool: :arrow: :???: :?: :!:

map