6 Grundsätze für das technische Schreiben, die Ihre Dokumentationen benutzerfreundlicher machen

6 Technical Writing Principles To Make Your Documentations More User-Friendly

Eine benutzerfreundliche Dokumentation ist für jeden technischen Redakteur eine gelungene Dokumentation. Das Schreiben einer solchen kann jedoch schwierig sein, vor allem wenn man für ein breites Publikum schreibt, das diverse Länder und Sprachen umfasst. Hier stellen wir Ihnen effektive Grundsätze für das technische Schreiben vor, die Ihnen beim Schreiben benutzerfreundlicher Hilfematerialien als Orientierungshilfe dienen können.

Grundsätze für das technische Schreiben benutzerfreundlicher Dokumentationen

Sehen wir uns diese Grundsätze im Einzelnen genauer an...

1. Erläutern Sie komplizierte Begriffe

Einer der wichtigsten Gründe dafür, dass viele Produktbenutzer Hilfedateien nicht lesen, ist die in den Dateien enthaltene Fachsprache. Was für Sie als technischer Redakteur ein einfacher Fachausdruck sein mag, kann für einige Benutzer einer der kompliziertesten Begriffe sein, denen sie je begegnet sind.

Wenn Sie also zum Beispiel einen komplizierten Prozess beschreiben wollen, empfiehlt es sich, ihn den Benutzern anhand von Beispielen zu erläutern. Jedes Beispiel, das Sie anwenden, kann Ihrem Inhalt mehr Klarheit geben.

Wenn Sie beispielsweise drei Beispiele zum Erklären eines schwer verständlichen Begriffs oder Fachausdrucks anwenden, werden Ihre Benutzer ihn besser verstehen, als wenn Sie nur ein Beispiel anwenden. Wobei nicht unbedingt jeder Begriff oder Fachausdruck einem Beispiel bedarf. Bedenken Sie jedoch immer, dass Beispiele ein wichtiges Werkzeug des technischen Schreibens sind, um Benutzern komplexe Informationen auf eine leichter verständliche Weise mitzuteilen.

2. Sorgen Sie für ein Gleichgewicht zwischen Text und Bildmaterial

Hilfedokumentationen und Gebrauchsanweisungen müssen nicht langweilig sein. Fügen Sie Bildmaterial hinzu, um Ihre Dokumentationen attraktiv zu gestalten. Ob Arbeitsablaufpläne, kommentierte Screenshots, Diagramme, Zeichnungen oder einfach nur Fotos, Bildmaterialien bereichern Ihre Dokumentationen.

Bildmaterialien ergänzen den Text, bieten ein zusätzliches Erklärungsformat, sprechen den visuellen Lernmodus des menschlichen Gehirns an und dienen Ihren Benutzern als Kurzanleitung bei der Durchführung von Aufgaben. Bildmaterialien können schwierig herzustellen sein, lohnen sich jedoch auf jeden Fall.

Wenn Sie vorhaben, Ihre Dokumentationen in mehrere Sprachen zu übersetzen, oder beabsichtigen, den Schwerpunkt mehr auf Codebeispiele als auf Bildmaterialien zu legen, brauchen Sie mitunter auch nur wenige Abbildungen. Wobei das nicht bedeuten soll, dass Sie nicht versuchen sollten, nach Möglichkeit mit Bildmaterialien zu kommunizieren. Bildmaterialien sind auch ohne Text so gut wie jedem länderübergreifend verständlich.

3. Testen Sie Ihre Anleitungen als erster

Zur Beurteilung Ihrer Hilfematerialien sollten Sie Ihre Anleitungen durchgehen und die Aufgaben selbst durchführen. Das eigene Testen der Anleitungen mag selbstverständlich erscheinen und im Fall von GUI-Dokumentationen ist es das in der Regel auch. In Wirklichkeit ist es jedoch oft schwierig durchzuführen.

Es lässt sich jedoch ziemlich einfach feststellen, wann ein technischer Redakteur eine Dokumentation ausschließlich anhand von Informationen, die jemand anderes ihm mitgeteilt hat, anstatt von selbst in Erfahrung gebrachten Informationen geschrieben hat. Achten Sie also stets darauf, Ihre Anweisungen selbst durchzugehen und zu testen.

4. Arbeiten Sie mit der Qualitätssicherung zusammen, um Testfälle für das, was Sie dokumentieren, zu bekommen

Wenn Sie als technischer Redakteur arbeiten, sollten die Kollegen in der Qualitätssicherung Ihre besten Freunde sein. Denn sie kennen das System in der Regel am besten. Sie erstellen Testumgebungen zum Gewährleisten der Funktionalität, und oftmals haben sie für jede Version eine Reihe von Testfällen (zu testender Funktionen).

Wenn Sie zum Beispiel eine API dokumentieren, haben die QS-Ingenieure möglicherweise bereits einsatzbereite Testpläne. Das Schreiben von Dokumentationen kann mit Hilfe der QS-Abteilung deutlich einfacher sein.

Dennoch verfügt die Qualitätssicherung in einigen Fällen mitunter nicht über die übergeordneten Informationen hinsichtlich der verschiedenen Szenarien, für die eine bestimmte Funktion verwendet werden kann. In vielen Fällen testet sie nur, ob die Funktion funktioniert. Möglicherweise müssen Sie die Produktmanager konsultieren, um einen Überblick darüber zu bekommen, für was die Funktion verwendet wird. Dennoch gilt insgesamt, dass eine Zusammenarbeit mit Ihrem Qualitätssicherungsteam Ihnen Ihre Arbeit sehr viel einfacher machen kann.

5. Berücksichtigen Sie das Feedback Ihrer Benutzer in Ihrer Bewertung

Um den tatsächlichen Wert Ihrer Dokumentationen zu verstehen, werden Sie direkte Rückmeldungen der Benutzer brauchen. Sie können keine logische Schlussfolgerung auf der Basis von Annahmen ziehen. Die Frage, ob Ihre Benutzer die Dokumentation verstehen, ob sie ihren Anforderungen gerecht wird usw. lässt sich nur dann konkret beantworten, wenn Sie ein konkretes Feedback der Zielpersonen, die Ihre Hilfematerialien anwenden, bekommen.

Hier erfahren Sie mehr über die Publikumsanalyse im technischen Schreiben.

Um das Feedback von Benutzern berücksichtigen zu können und Ihr Hilfematerial richtig zu bewerten, sollten Sie erwägen, direkt mit ihnen (zum Beispiel durch ein Call-Center, ein soziales Netzwerk oder Forum) in Kontakt zu treten. Vergessen Sie dabei nicht, dass es schwierig ist, die eigene Hilfedatei allein anhand der eigenen Erfahrung zu bewerten. Dies gehört zu den 5 wichtigsten Fähigkeiten, die Sie als hervorragender technischer Redakteur benötigen.

Und selbst wenn Sie alle Anweisungen geprüft und festgestellt haben, dass sie funktionieren, kann es sein, dass Sie zu vertraut mit ihnen sind und sie deshalb schnell abhaken. Oder Sie vergessen möglicherweise etliche erforderliche Informationen oder missinterpretieren die Bereitstellungsplattformen, Szenarien usw.

6. Veröffentlichen Sie Ihre Hilfematerialien in einem benutzerfreundlichen Format

Beschränken Sie Ihre Hilfematerialien nicht auf nur ein oder zwei Formate. Benutzer haben oft Zugriff auf mehrere verschiedene Geräte und Betriebssysteme. Hier finden Sie einen Überblick über die 7 besten Formate zum Veröffentlichen Ihrer Hilfematerialien.

Mit einem Hilfe-Entwicklungstool wie beispielsweise HelpNDoc können Sie Ihre Inhalte in mehreren verschiedenen Formaten (z. B. als Windows-CHM-Hilfedateien, WEB-basierte Dokumentationen, iPhone-spezifische Websites, druckbare PDF- und Word-Dokumente, ePub- und Kindle-E-Books und plattformübergreifende Qt-Hilfedateien) dokumentieren und veröffentlichen. HelpNDoc ist für den persönlichen Gebrauch und zu Bewertungszwecken kostenfrei.

Viel Freude am Dokumentieren!