Wenn Sie Anleitungen schreiben, vermeiden Sie eine überredende Sprache und verfolgen Sie einen aufgabenorientierten Ansatz. Halten Sie den Text kurz und klar und konzentrieren Sie sich darauf, den Benutzer in die Lage zu versetzen, die Aufgabe erfolgreich zu bewältigen.
Befolgen Sie im Allgemeinen diese Richtlinien:
Kürze und Klarheit
Halten Sie die Sätze kurz und verständlich. Verwenden Sie, wann immer möglich, allgemeine Terminologie. Vermeiden Sie Redewendungen, Slang, Jargon, Spitznamen, Abkürzungen und Akronyme. Wenn Sie Begriffe verwenden, die neu oder verwirrend sein könnten, definieren Sie sie klar, wenn sie zum ersten Mal in der Anleitung erscheinen.
Zielgruppe
Es ist wichtig, dass Sie Ihre Zielgruppe kennen, wenn Sie Anleitungen schreiben, damit Sie alle notwendigen Informationen einbeziehen und unnötige Informationen ausschließen. Wenn Sie Ihre Zielgruppe kennen, können Sie vernünftige und fundierte Annahmen treffen, die auf dem wahrscheinlichen Hintergrund, der Erfahrung und der Vertrautheit der Zielgruppe mit dem Thema basieren. Wenn Sie zum Beispiel eine Anleitung für eine Gruppe von Senioren in der örtlichen Zweigstelle der öffentlichen Bibliothek schreiben, können Sie nicht davon ausgehen, dass diese mit den Grundlagen des Öffnens einer bestimmten Softwareanwendung vertraut sind. Wenn Sie jedoch eine Anleitung für eine Gruppe von Softwareentwicklern innerhalb einer professionellen Organisation schreiben, können Sie davon ausgehen, dass diese mit den Grundlagen des Öffnens einer bestimmten Softwareanwendung vertraut sind.
Bei der Entscheidung, welche Informationen in die Anleitung aufgenommen und welche ausgeschlossen werden sollen, ist es wichtig, klar zu erkennen, wer Ihre Zielgruppe ist und wie hoch deren wahrscheinliche Kenntnisse über das Thema der Anleitung und die damit verbundenen Hintergrundinformationen sind.
Wenn die Zielgruppe über ein breites Erfahrungs- und Wissensspektrum verfügt, das unterschiedliche Niveaus an Vertrautheit und Fachwissen umfasst, können Sie verschiedene Techniken anwenden, um die einzelnen Anleitungen kurz zu halten und sich auf eine einzige Aufgabe zu konzentrieren, aber dennoch die notwendigen Informationen bereitzustellen. So können Sie z. B. separate Anleitungen für vorausgesetzte Informationen erstellen und Ihrem Publikum die Möglichkeit geben, schnell und einfach auf die separaten Anleitungen zuzugreifen (durch Hyperlinks, Anhänge usw.).
Grafiken
Bilder sagen mehr als Worte. Das Hinzufügen von Grafiken zur Vermittlung Ihrer Gedanken kann wirksamer sein als die Worte selbst. Anleitungen, die gut illustriert sind und Ihre schriftlichen Anweisungen begleiten, sind in der Regel sehr erfolgreich. Sie sorgen für eine zusätzliche Verständnisebene und ermöglichen es dem Leser, die Anleitung zu überfliegen oder bei Problemen eine Fehlersuche vorzunehmen. Bilder fügen eine zusätzliche Dimension hinzu, die es dem Leser ermöglicht, sich das Endprodukt vorzustellen. Bei der Verwendung von Grafiken sollten Sie auch an die visuellen Lernenden denken und die Grafiken anpassen.
Obwohl Bilder großartig sind, müssen Sie darauf achten, dass Sie keine Fotos oder Illustrationen verwenden, die verwirrend sind oder nicht mit den eigentlichen schriftlichen Anweisungen in Verbindung stehen. Wenn Sie Ihren Anweisungen ein schlechtes Bild beifügen, könnten Sie dem Leser Stress bereiten oder Verwirrung stiften, wenn er versucht zu entziffern, was Sie meinen.
Auch sollten Sie beim Fotografieren darauf achten, dass der Bereich gut beleuchtet ist und die Bilder klar und hell sind. Dunkle oder unscharfe Bilder sind oft schwer zu verstehen. Achten Sie darauf, das Motiv jedes Mal in der gleichen Ausrichtung zu fotografieren, um Verwirrung zu vermeiden, und erwägen Sie die Verwendung eines Stativs.
Auch die Größe ist wichtig, wenn Bilder in Anleitungen verwendet werden. Ein Bild, das zu klein ist, um es zu erkennen, ist genauso nutzlos wie ein unscharfes Bild.
Um aussagekräftig und verständlich zu sein, sollten der Text und die Grafik für jeden Schritt klar mit dem jeweiligen Schritt der Anleitung korrelieren.
Formatierung
Denken Sie daran, dass die Leser die Aufgabe tatsächlich ausführen werden, während sie die Anleitung lesen. Daher sollten Sie keine großen Blöcke mit kleinem, schwer zu entzifferndem Text verwenden. Achten Sie auf ein Design und ein Layout für Ihre Anleitungsseite, das eine leichte Lesbarkeit ermöglicht und eine ästhetische Qualität bietet. Eine einfache, aber hierarchisch aufgebaute Seite hilft dem Leser, die einzelnen Schritte der Anleitung auszuführen.
Bei der Gestaltung Ihrer Seite ist eine solide Hierarchie wichtig für die Lesbarkeit. Fettgedruckte Überschriften, kursive Schrift und römische Ziffern helfen dem Leser, sich leicht zurechtzufinden, und tragen zum optischen Gesamteindruck bei.
Reihenfolge
Es ist wichtig, dass Ihre Anweisungen in einer logischen Abfolge geplant werden. Achten Sie darauf, dass Sie das Problem auf der ersten Seite klar formulieren. Im Anschluss an die Problemstellung sollten Sie eine Reihe spezifischer Schritte zur Lösung des vorgeschlagenen Problems angeben. Technische Anleitungen müssen nach einem logischen Muster ablaufen. Wenn Sie zum Beispiel einen Tisch zusammenbauen, wäre es nicht gut, wenn Sie den letzten Schliff geben, bevor Sie alle Schrauben angebracht haben. Wie bereits erwähnt, sollten auch klare Grafiken vorhanden sein, um die Handlung zu verdeutlichen. Denken Sie daran: Ein Bild sagt mehr als tausend Worte.
Test und Überprüfung
Wir alle wissen, dass es schwierig ist, Anleitungen zu schreiben, und dass es sich manchmal auf dem Papier gut anhört, aber wenn Sie versuchen, die Anleitungen in die Praxis umzusetzen, werden Sie vielleicht feststellen, dass Ihre Formulierungen für andere keinen Sinn ergeben. Denken Sie daran, dass das, was für Sie alltäglich oder offensichtlich ist, Ihre Leser verwirren könnte, also kennen Sie Ihr Publikum. Testen Sie Ihre Anleitungen nicht nur an sich selbst, sondern lassen Sie sie auch von jemandem testen, der nichts über Ihr Produkt weiß. Dies nennt man eine Nutzbarkeitsstudie. Machen Sie sich Notizen darüber, was funktioniert hat und was nicht, und überarbeiten Sie dann Ihre Anleitungen entsprechend. Je mehr Personen Ihre Anleitungen testen, desto effektiver wird die endgültige Fassung sein.