Technische Redakteure erstellen verschiedene Arten von Dokumentation, zum Beispiel Benutzerhandbücher, API-Dokumentation, Leitfäden und so weiter. Ich habe einen Artikel darüber geschrieben, wie man ein Benutzerhandbuch schreibt, also erzähle ich Ihnen heute, wie man einen Leitfaden erstellt.
Wenn Sie die Aufgabe bekommen, einen Leitfaden zu erstellen, sollten Sie zuerst planen. Hier ist, was Sie tun sollten:
Verstehen Sie Ihre Zielgruppe
Wenn Sie mit dem Schreiben Ihres Leitfadens beginnen, sollten Sie genau wissen, wer Ihre Zielgruppe ist. Wie alt ist sie, welchen Hintergrund hat sie und so weiter. Dies wird den Stil Ihres Leitfadens auf der grundlegenden Ebene bestimmen – die Komplexität der verwendeten Sprache, die Anzahl der Begriffe und viele andere Merkmale.
Recherche über den Prozess
Ich empfehle Ihnen, über die Erfahrungen anderer Leute beim Schreiben von Leitfäden zu lesen. Das wird Ihnen helfen, sich ein klares Bild von der zukünftigen Arbeit zu machen, und Sie können die Ansätze anderer in Ihren Arbeitsprozess integrieren. Ich habe zum Beispiel über den Prozess des technischen Schreibens von Amrute Ranade geschrieben; Sie können den Artikel hier lesen: Großartiger technischer Schreibprozess“. Sie können diese Methode also auch verwenden, um Ihr technisches Schreiben zu erleichtern.
Sammeln Sie nützliche Materialien
Bevor Sie mit dem Schreiben beginnen, sammeln Sie Material und Informationen, die Ihnen helfen werden, eine Anleitung zu schreiben. Das können zusätzliche Informationen zu einem Produkt, andere Anleitungen zu ähnlichen Produkten oder etwas anderes sein.
Schreiben Sie Ihren Leitfaden
Zuallererst erstellen Sie einen Plan – es wird einfacher sein, einen Leitfaden zu schreiben, wenn Sie ihn sich vorstellen. Nach all diesen Vorbereitungen ist es nun höchste Zeit, mit dem Schreiben zu beginnen. Bei der Erstellung eines Leitfadens sollten Sie die folgenden Tipps beachten:
- Schreiben Sie in einfachem Englisch, um die gleiche Sprache wie Ihre Leser zu sprechen.
- Ihre Sprache sollte immer prägnant sein (z.B., „Wählen Sie die Option“ statt „Sie sollten die Option wählen“).
- Erstellen Sie nummerierte Listen, um die Schritte zu strukturieren, wenn ein Benutzer sie ausfüllen muss
- Fügen Sie visuelle Inhalte wie Fotos, Screenshots und Diagramme hinzu.
- Unterteilen Sie den Inhalt in Überschriften, aber schreiben Sie sie deutlich
- Wenn Sie Witze verwenden wollen, seien Sie vorsichtig: die Leute verstehen Sie vielleicht nicht
- Fügen Sie Mini-TOCs hinzu, um große Themen lesbarer zu machen.
Der wichtigste Tipp ist der folgende – Rechtschreib- und Grammatikfehler sind in der Dokumentation inakzeptabel, also überprüfen Sie Ihren Leitfaden gründlich. Hier finden Sie eine Liste der besten kostenlosen Grammatikprüfprogramme. Sie können auch eine andere Person bitten, für Sie Korrektur zu lesen, oder Ihre eigenen Schritte rückwärts lesen, um sicherzustellen, dass Ihr Text klar und einfach ist. Hier sind einige weitere Ressourcen für das Verfassen hervorragender Dokumentationen:
- Grammatikbücher für technische Redakteure
- Style Guides for Technical Writers
Natürlich ist das nicht alles, was man über das Schreiben von „How to“-Anleitungen wissen muss, aber diese Tipps sind meiner Meinung nach die wichtigsten. Ich hoffe, sie helfen Ihnen.
Viel Erfolg beim Verfassen von Leitfäden!