Inhalt
- Versetzen Sie sich in die Schuhe des Lesers
- Was Sie über Ihre Leser verstehen müssen
- Ihre Leser sind bereits frustriert
- Ein Hinweis, bevor Sie mit dem Schreiben von Anweisungen beginnen
- Die Zauberformel zum Schreiben von Anweisungen
- Die Zauberformel: Die gegebene neue Methode
- Jetzt können Sie gute Anweisungen schreiben
- Endgültige Reinigung
- Usability Testen Sie Ihre Anweisungen
- Schlussfolgerungen und Verallgemeinerungen
Laura ist technische Redakteurin. Sie spielt gerne Klavier, reist gern, macht Kunst und macht Schmuck.
Versetzen Sie sich in die Schuhe des Lesers
Um bessere Anleitungen oder Verfahren für Computer zu schreiben, müssen Sie sich zuerst in die Lage des Lesers oder Benutzers versetzen.
Der Benutzer weiß nichts über Ihre Website oder Software und wird sich nicht die Zeit nehmen (und sollte es auch nicht müssen), um die gesamte Anleitung zu lesen, bevor er mit seiner Arbeit beginnt. Der Benutzer verwendet Ihr Produkt einfach, um ein bestimmtes Ziel zu erreichen (Kauf tätigen, Informationen nachschlagen usw.).
Was Sie über Ihre Leser verstehen müssen
Das wichtigste zuerst. Sie müssen die Tatsache akzeptieren, dass Ihre Leser höchstwahrscheinlich nicht lesen möchten, was Sie geschrieben haben. Dies bedeutet, dass Sie zum Schreiben effektiver, hilfreicher Anweisungen zunächst alle folgenden Wahrheiten akzeptieren müssen:
- Ihre Leser / Benutzer möchten nicht lernen, wie Sie Ihr Produkt / Ihre Dienstleistung verwenden. Sie wollen eine eigene Aufgabe oder ein eigenes Ziel erreichen.
- Sie lasen die Dokumentation nur verzweifelt, nachdem das, was sie versuchten, fehlgeschlagen war.
- Sie sind jetzt frustriert.
- Sie wissen nicht, wie sie vorgehen sollen, um ihr Ziel / ihre Aufgabe zu erreichen.
Ihre Leser sind bereits frustriert
Als Verfasser von Anweisungen befinden Sie sich in einer schlechten Situation, da Benutzer (die Sie wahrscheinlich nicht kennen und die Sie nie treffen werden) bereits mit Ihrem Produkt / Ihrer Dienstleistung frustriert sind, wenn sie sich den Anweisungen zuwenden, auf denen Sie geschrieben haben wie man jede Aufgabe erfüllt. Seien Sie also freundlich zu ihnen und geben Sie ihnen klare, präzise, endgültige und genaue Anweisungen, die sie wieder auf den Weg bringen, ihr Ziel so schnell wie möglich zu erreichen: Es ist eine Form des guten Kundenservice!
Das Muster wird recht einfach und ist auf die meisten Arten von Schritt-für-Schritt-Anweisungen anwendbar, nicht nur auf Computeranweisungen.
Ein Hinweis, bevor Sie mit dem Schreiben von Anweisungen beginnen
Bevor Sie mit dem Schreiben von Anweisungen beginnen, müssen Sie wissen, in welchem Stil sie geschrieben werden sollen.
Fragen Sie nach einem "House Style Guide" (die Marketingabteilung ist ein guter Ausgangspunkt) und erhalten Sie die neueste Version des Microsoft Manual of Style für technische Veröffentlichungen.Aber was ist mit Apple Macintosh-Benutzern? Sie sind entweder bereits mit dem Microsoft-Schreibstil vertraut oder werden nicht verwirrt, da Sie den Schreibstil in der gesamten Bedienungsanleitung konsistent implementieren.
Ein Wörterbuch und ein Thesaurus schaden auch nie, obwohl diese auch im Internet zu finden sind und welche im House Style Guide angegeben werden sollten. Verwenden Sie im Zweifelsfall Merriam Webster, den "Goldstandard" der Wörterbücher.
Die Zauberformel zum Schreiben von Anweisungen
| Wo bin ich? | Was sollte ich tun? | Was ist passiert? |
|---|---|---|
Sagen Sie dem Leser, wo sie sind → | Sagen Sie ihnen, was zu tun ist → | Beschreiben Sie die Ergebnisse ihrer Aktionen |
Die Zauberformel: Die gegebene neue Methode
Jetzt kennen Sie eine der Grundlagen der technischen Kommunikation, unabhängig davon, ob Sie ein professioneller Schriftsteller sind oder nicht. Es ist auch als gegeben-neu-Methode bekannt, weil Sie dem Leser zunächst etwas sagen, das er bereits kennt, ein "gegebenes", und ihm dann etwas "neues" geben. Klare Titel / Überschriften sind hier der Schlüssel zum Erfolg.
Beachten Sie, dass diese Methode dem bereits frustrierten Leser / Benutzer hilft, schnell zu verstehen, ob Ihr bestimmtes Verfahren auf seine Situation zutrifft, weil Sie ihm einen eindeutigen Titel gegeben haben, ob er sich am richtigen Startplatz befindet (weil Sie ihm gesagt haben, wo er anfangen soll), was zu tun ist an diesem Punkt tun, und wie die Ergebnisse aussehen sollten.
Jetzt können Sie gute Anweisungen schreiben
Nachdem Sie die Regeln für das Schreiben kennen, können Sie jederzeit mit dem Schreiben der Anweisungen beginnen, wobei Sie die Perspektive des Benutzers berücksichtigen.
Sie benennen die Anweisungen mit "Wie man Aufgabe ABC erledigt" und stellen sicher, dass die Anweisungen unter dieser Überschrift alle mit der Ausführung von Aufgabe ABC zu tun haben (und sonst nichts). Jetzt können Sie die Anweisungen selbst schreiben.
Das erste, was Sie tun müssen, ist, die Benutzer zu orientieren: Sagen Sie den Benutzern, wo sie sich befinden und was sie auf ihrem Bildschirm sehen sollen, z. B. den Namen des Fensters, das sie betrachten sollen. Sagen Sie ihnen als Nächstes, welche Schaltflächen im aktuellen Fenster angezeigt werden sollen und / oder welchen Text sie in welche Felder eingeben müssen. Sagen Sie ihnen als Nächstes, wie sie zum nächsten Schritt / Ort gelangen, und beschreiben Sie, was sie auf dem Bildschirm sehen sollen, wenn sie diese Aktion ausführen.
Beispielsweise:
- Von dem HauptfensterWählen Sie alle Optionen aus, die Sie aktivieren möchten. Klicken OK. Das Zweites Fenster wird angezeigt und zeigt den aktuellen Status der von Ihnen ausgewählten Optionen an.
- Auf der Zweites FensterStellen Sie sicher, dass alle ausgewählten Optionen korrekt sind.
- Wenn alle Optionen korrekt sind, klicken Sie auf Optionen aktivieren. Das Drittes Fenster erscheint.
- Wenn nicht alle Optionen korrekt sind, klicken Sie auf Zurück um zum zurückzukehren Hauptfenster und wählen Sie verschiedene Optionen.
Endgültige Reinigung
Wenn Sie mit dem Schreiben fertig sind, führen Sie die Rechtschreib- und Grammatikprüfung durch und lassen Sie das Dokument von einem oder mehreren Fachexperten (KMU) - Personen, die das Produkt kennen - überprüfen. Nehmen Sie Änderungen vor, führen Sie die Rechtschreib- und Grammatikprüfung erneut aus und lassen Sie das Dokument von jemandem Korrektur lesen / bearbeiten.
Sobald Sie die vom Editor vorgenommenen Änderungen eingegeben haben, sind Sie im Allgemeinen fertig (es sei denn, Ihr Unternehmen verfügt über einen formellen Prozess zur Freigabe von Dokumenten, dem Sie folgen sollten).
Beachten Sie, dass die von den Fachexperten und dem Herausgeber vorgenommenen Änderungen (der Fachexport nach dem genauen Wortlaut und Stil) fast ohne Frage akzeptiert werden sollten: es ist ihr Aufgabe, ihr Fachgebiet zu kennen. Wenn du stark einer Änderung nicht zustimmen, erst dann das KMU oder den Herausgeber darauf aufmerksam machen. Andernfalls nehmen Sie die vorgeschlagenen Änderungen vor.
Usability Testen Sie Ihre Anweisungen
Wenn Sie einen sehr guten Entwurf haben, rekrutieren Sie mehrere Personen, um Ihre Anweisungen zu testen - um sie von Anfang bis Ende durchzugehen und alle Bereiche zu notieren (und zu notieren), in denen sie verloren gehen oder verwirrt sind oder in denen die Anweisungen falsch sind.
Im Idealfall sollten Usability-Tester die tatsächlichen Kunden / Benutzer des von Ihnen dokumentierten Produkts / der Website sein. Zur Not ist es jedoch besser als nichts, ein paar Leute aus dem Büro zu rekrutieren, die mit dem, worüber Sie geschrieben haben, nicht vertraut sind, und sie das Dokument testen zu lassen. Beachten Sie in diesem Fall, dass die Tester die Fachexperten sind, sodass ihre Änderungen genauso wertvoll sind wie die Ihrer Produkt-KMU und Ihres Herausgebers (KMU).
Usability-Tests selbst sind eine ganze Disziplin, die zu weit gefasst ist, um in diesem Artikel behandelt zu werden.
Sobald Sie jedoch Änderungen an den Usability-Tests vorgenommen haben, führen Sie die Änderungen am Editor und gegebenenfalls an Ihren Produkt- / Dienstleistungs-KMU vorbei: Möglicherweise würde eine kleine Änderung des Produkts / der Dienstleistung, entweder jetzt oder in einer zukünftigen Version, einen großen Unterschied bewirken an die Benutzer.
Schlussfolgerungen und Verallgemeinerungen
Wir können die folgenden Schlussfolgerungen und Verallgemeinerungen zum Schreiben von Softwareanweisungen ziehen:
- Die Leser sind frustriert, wenn sie Ihre Arbeit lesen.
- Sie müssen den Leser beruhigen, indem Sie ihm sagen, wo er sich befindet, was zu tun ist und wo er landen wird.
- Sie müssen Ihr Dokument von Experten auf Produktgenauigkeit und Schreibgenauigkeit überprüfen lassen.
- Sie müssen die von Ihren Experten vorgenommenen Änderungen akzeptieren, es sei denn, Sie bedeutend In diesem Fall sprechen Sie mit dem betreffenden Experten über das Problem.
- Usability-Tests sind der beste Weg, um sicherzustellen, dass Ihr Dokument die Anforderungen der Benutzer / Leser erfolgreich erfüllt. Dies kann sogar zu Produktverbesserungen führen!
Dieser Artikel ist genau und nach bestem Wissen des Autors. Der Inhalt dient nur zu Informations- oder Unterhaltungszwecken und ersetzt nicht die persönliche Beratung oder professionelle Beratung in geschäftlichen, finanziellen, rechtlichen oder technischen Angelegenheiten.
