Ein gutes Informationsprodukt für Ihre Anwender:innen ist in erster Linie genau das: Für Ihre Anwender und Anwenderinnen. Wichtig bei der Fokussierung auf die Zielgruppe ist, dass Sie mit der Anleitung das Wissen und Können sowie die Bedürfnisse, Ziele und Betrachtungswinkel Ihrer Zielgruppen aufgreifen und befriedigen. Doch wie kann man das erreichen und vor allem sicherstellen, dass die Dokumente diese Qualitätskriterien erfüllen?

In einem Punkt sind sich alle Stakeholder meistens einig: Ist Ihr Informationsprodukt auffindbar, nützlich, vollständig und korrekt, trägt es erheblich zur besseren User-Experience bei.

Damit das gelingt, gilt es folgende Qualitätskriterien mit Ihren Informationsprodukten zu erfüllen:

• Verzichten Sie auf Slang und Fachjargon
• Schreiben Sie aus der Perspektive Ihrer Anwender:innen
• Schreiben Sie inhaltlich vollständig und verständlich.
• Vermitteln Sie gleichzeitig nur, was Ihre Anwender:innen wirklich brauchen.
• Erklären Sie in einfachen Worten, werden Sie konkret!

Damit die Technische Redaktion dies gewährleisten kann, gibt es diverse Werkzeuge und Methoden, auf die wir als Autor:innen zurückgreifen. So zum Beispiel der Dokumentationsplan oder der Redaktionsleitfaden.

Ist die Anleitung oder auch nur ein einzelnes Topic erstellt, geht es meist ins Review. Die nach Wörterbuchdefinition: „Kritische Besprechung eins Produkts o.Ä.“ oder auch das „Kannst du mal querlesen?“, „lass mal mit vier Augen prüfen“ oder „Kannst du mal überfliegen, bitte?“ im Reaktionsalltag.

Was so leichtfüßig klingt, ist aber keineswegs witzig. Fakt ist, dass die Technische Dokumentation enorm vielen, parallelen Qualitätsanforderungen, gerecht werden muss. Hier den Überblick zu behalten, ist oft schwierig.

Aber wie kann das gehen? Eines der Werkzeuge, die Sie dafür einsetzen können, ist die problemtypologische Analyse.

Was ist Problemtypologie?

Die Problemtypologie in der Technischen Dokumentation ermöglicht es Ihnen, bei der Analyse von Anleitungen für Maschinen, Anlagen, Software oder andere Produkte, Qualitätsprobleme exakt zu benennen und gleichzeitig auch eine Problemlösung auszusprechen.

Warum Problemtypologie einsetzen?

Mit Hilfe der Problemtypologie können Sie die Problembereiche Ihrer Technischen Dokumentation zuordnen und benennen. Sie ermöglicht Ihnen dadurch, sich beim Review Ihrer Anleitungen untereinander besser zu verstehen. Dadurch profitieren beide Seiten:

• Den Reviewer:innen fällt es leichter, erkannte Probleme zu benennen.
• Den Autor:innen fällt es leichter, die erkannten Probleme aufzunehmen und zu Lösen.

Schwachstellen werden in Anleitungen dadurch frühzeitig aufgedeckt und mit der Zeit schärfen auch Ihre Technischen Redakteur:innen ihren Blick für (un)gewöhnliche Probleme in ihren Informationsprodukten.

„Problemtypologie bringt Probleme und Ihre Ursachen auf den Punkt!“

Welche Problemtypen gibt es?

Die Problemtypologie unterscheidet nach Qualitätsanforderungen und unterteilt diese in Problemursachen, die der jeweiligen Qualitätsanforderung widersprechen. Die Problemursachen wiederum, werden mit einem Kürzel an der Stelle angemerkt, an der diese auftreten.

Wann Sie welche Problemursache für das jeweilige Kriterium setzen, differenzieren Sie nach Aspekten, die der Problemursache zugrunde liegen.

Ein Beispiel:

Eine wichtige Qualitätsforderung einer Anleitung ist die sachliche Richtigkeit sowie die Relevanz der Informationen, die darin enthalten sind. Die Qualitätsforderung in der Problemtypologie lautet: „Sachliche Richtigkeit und Relevanz“.

Fehlen wichtige Angaben in der Anleitung, die für Ihre Anwender:innen relevant sind, dann haben wir hier ein Problem erkannt. Die Problemursache lautet: „Fehlende Angabe“. Das passende Kürzel dazu: „FA“.

Doch wie erkennen wir Probleme vom Typ „Fehlende Angaben“? Dies kann zum Beispiel der Fall sein, wenn:

• Fehlende Angaben im Text identifiziert wurden, die für die Ausführung der Tätigkeit relevant sind.
• Handlungsschritte in der Anleitung fehlen.

Dabei sind diese Kriterien nicht in Stein gemeißelt. Für Ihre Zwecke könnte es noch weitere relevante Aspekte geben, die für Sie die Klassifikation des Problemtypen „Fehlende Angabe“ zur Folge hat.

Weitere Problemursachen können z.B. „Überflüssige Angaben“, „Wortschatz“, oder „Schreibfehler“ sein. Bei letzterer wiederum erfolgt die Auszeichnung im Dokument nach den Korrekturzeichen gemäß Normblatt DIN 16511.

Wo kann Problemtypologie noch helfen?

Die Problemtypologie dient, wie oben bereits beschrieben, im Wesentlichen der Analyse von Dokumentationen in der Technischen Redaktion. Sie kann, wird aber vorrangig nicht, für das tägliche Review im Redaktionsalltag eingesetzt werden. Vielmehr ist sie das Mittel, welches wir als Dienstleister zum Beispiel für die Analyse von Bestandsdokumentationen bei unseren Kunden einsetzen.

Die Problemtypologie hilft uns dabei, die Probleme und Herausforderungen, die wir in den Informationsprodukten unserer Kunden aufdecken, zu benennen und bei der Aufbereitung der Analyse-Ergebnisse in einer einfachen, allgemeinverständlichen Terminologie darzustellen.

Aber auch für Sie in Ihrer Technischen Redaktion kann die Problemtypologie dienlich sein, wenn Sie zum Beispiel Ihre eigenen Anleitungen in regelmäßigen Abständen nach dieser Methode prüfen.

Sie hilft Ihnen auch bei Usability-Tests für Ihre Technische Dokumentation, die aufgedeckten Schwachstellen schnell und verständlich zu benennen, damit Sie die Ergebnisse später auswerten können. So können Sie sich vollkommen auf die Beobachtung Ihrer Nutzergruppen konzentrieren.

Wie profitieren Technische Redaktionen von Problemtypologie?

Ist die „Sprache“ der problemtypologischen Analyse in Ihrer Technischen Redaktion etabliert, schärft dies das Innere Auge Ihrer Technischen Redakteur:innen für die gute Qualität in Anleitungen. Autor:innen erkennen Probleme in ihren Anleitungen „früher“ und die Fehlerquoten sinken. Gleichzeitig werden dadurch Optimierungspotentiale in ihren Anleitungen aufgedeckt. Die offenen Punkte können eingeplant und kontinuierlich verbessert werden.

Selbstverständlich gibt es noch weitere Problemursachen, die auch für andere Qualitätsanforderungen in der Technischen Dokumentation einen Bruch darstellen. Leider können wir Ihnen an dieser Stelle nicht alle vorstellen. Sie wollen mehr über Problemtypologie erfahren oder Ihre eigene Technische Dokumentation durch unsere Experten auf den Prüfstand stellen? Dann nehmen Sie gerne Kontakt auf! Wir freuen uns auf den Austausch.