Feedback, bitte! – Warum Technische Redaktion keine Einbahnstraße sein sollte

Martin Häberle arbeitet als Technischer Redakteur für ein mittelständisches Software-Unternehmen und ist Lehrbeauftragter an der Hochschule Gießen im Studiengang „Technische Redaktion und Multimediale Dokumentation“ für Wiki-basierte Dokumentation. Zu diesem Thema ist er auch als Berater, Trainer und Autor u.a. für die K15t Software GmbH tätig.

(c) K15t Software

(c) K15t Software

Lange Zeit war Technische Redaktion eine Einbahnstraße. Wir schickten Informationen in die eine Richtung, und aus der anderen kam nichts zurück. Doch in Zeiten des Web 2.0 ist das zu wenig. Technische Redakteure müssen heute kommunizieren und interagieren können – auch mit ihren Lesern. Feedback hilft ihnen dabei, Technische Inhalte nutzergerecht zu erstellen und kontinuierlich zu verbessern. Anstelle der Einbahnstraße ist Technik-Kommunikation heute ein iterativer Prozess, funktioniert also eher wie ein Kreisverkehr.  Für diese neuen Redaktionsprozesse benötigen wir neue Werkzeuge – weg von Redaktionssystemen oder DTP-Werkzeugen, hin zu kollaborativen Plattformen.

Lesen Sie in diesem Artikel, warum Feedback so wichtig ist, um hilfreiche Inhalte zu erstellen und wie Web-basierte Kollaborationswerkzeuge sowohl internes Feedback als auch Kundenrückmeldungen für Technische Dokumentation ermöglichen.

Gutes Feedback ist mehr als Lob

Feedback hat hier im Südwesten Deutschlands wenig Tradition. Denn in meinem Heimatland Baden-Württemberg heißt es „Net g’schimpft isch genug g’lobt“ und das bedeutet in der Praxis, dass man sehr wenig Feedback bekommt – sei es nun Lob oder Kritik. Dabei ist Rückmeldung wichtig, um besser zu werden! Gerade als Technischer Redakteure sind wir auf Feedback angewiesen. Nur so können wir hilfreiche Inhalte erstellen, die unsere Leser erwarten und den Nutzern Informationen bereitstellen, die sie wirklich benötigen.

Üblicherweise erhalten Technische Redakteure aber nur selten (nützliches) Feedback zu ihren Inhalten. Vielleicht kommen während der ohnehin viel zu kurzen Review-Phase ein paar handschriftliche Korrekturen von den Fachexperten hereingeflattert, und manchmal werden uns die Kollegen sogar mit ein paar erhellenden Erkenntnissen beglücken. Doch fast nie erhalten wir in der Technikkommunikation eine Rückmeldung von denjenigen, mit denen wir wirklich kommunizieren möchten: von den Leserinnen und Lesern.

Doch warum kommuniziert die Leserschaft nicht mit uns? Ein Grund für ausbleibendes Feedback ist, dass eine Beteiligung der Leserschaft in traditionellen Redaktionsprozessen entweder nicht vorgesehen ist oder nicht einfach und zuverlässig möglich ist. Erst die Web-2.0-Bewegung brachte entsprechende Web-basierte kollaborative Werkzeuge (z.B. Wikis) hervor – digitale Plattformen, auf denen Inhalte nicht nur konsumiert, sondern auch selbst erstellt werden können.

Moderne Web-basierte Plattformen gehen neue Wege, um Inhalte kollaborativ zu erstellen, zu überarbeiten und zu veröffentlichen. Dokumentation bereitzustellen ist damit nicht mehr länger ein Monolog gegenüber den Lesern, sondern wird zum Dialog. Der Technikredakteur wird endlich zum Technik-Kommunikator!

Der Content-Lebenszyklus „2.0“

In typischen Dokumentationserstellungs-Prozessen planen Technische Redakteure zunächst ihre Informationsprodukte, erstellen eine Struktur und recherchieren, bevor sie mit dem Erstellen der einzelnen Inhaltsbausteine loslegen. Die Entwürfe werden so lange angepasst und Überarbeitungen werden abgestimmt und zusammengeführt, bis jemand eine Freigabe erteilt und die Inhalte ins gewünschte Zielformat ausgegeben werden. Und schließlich gelangt die Dokumentation zu ihren Lesern.

(c) K15t Software

(c) K15t Software

Wenn wir einen kollaborativen Ansatz verfolgen, können wir noch eine fünfte Phase zu diesem Prozess hinzufügen: das aktive Einbeziehen unserer Leser („Engage“). Indem wir es ihnen ermöglichen etwas Inhaltliches beizutragen, schließt sich die Feedback-Schleife und wir beginnen miteinander zu kommunizieren. Auf Basis der Anregungen, Fragen und Wünschen ihrer Leser können Technische Redakteure ihre Dokumentation so kontinuierlich verbessern, wie dies beispielsweise in der agilen Software-Entwicklung praktiziert wird.

Im Wiki lässt sich jede Änderung nachverfolgen – der gesamte Prozess von der Erstellung bis zum Review wird transparent für alle Beteiligten. Und wenn wir Feedback sowohl beim internen Review als auch während der Nutzung der bereitgestellten Inhalte erhalten, dann wirkt sich das positiv auf die Qualität der Inhalte aus (entgegen einiger unhaltbarer Wiki-Mythen).

Feedback zu Inhalten im Entwurfsstadium

Während des internen Lektorats prüfen die eingeladenen Fachexperten unsere Inhalte. Sie kommentieren hier und dort, schließen ein paar Wissenslücken und klären inhaltliche Fehler und Missverständnisse mit den Technischen Redakteuren. Außerdem gibt es möglicherweise einen Schlussredakteur, der den Entwurf auch auf Sprache, Stil und Struktur prüft und dadurch eine gewisse Konsistenz und formale Richtigkeit sicherstellt. Schließlich wird der Entwurf freigegeben und publiziert.

In einer kollaborativen Plattform sind alle, die am Redaktionsprozess beteiligt sind, sprichwörtlich auf der gleichen (Wiki-)Seite. Soziale Funktionen wie Kommentare, ein „Gefällt mir“-Button oder die Möglichkeit, Inhalte einfach zu teilen, helfen den Nutzern, miteinander effizient zu kommunizieren und mit den Inhalten zu interagieren – sogar wenn die Beteiligten über verschiedene Standorte oder sogar Zeitzonen hinweg verteilt arbeiten.

Abhängig von der gewünschten Arbeitsweise ist die letzte Inhaltsversion entweder sofort online für die Nutzer verfügbar, oder es wird ein Freigabeschritt zwischengeschaltet.

Mit der Kollaborationsplattform Atlassian Confluence lassen sich beispielsweise Inhaltsfragmente aller Arten und Größen kommentieren, Überarbeitungen anregen und schließlich als gelöst markieren – und das mit wenigen Klicks und ohne das Browserfenster zu wechseln. Nutzer können Inhalte bei Bedarf hinzufügen, bearbeiten oder löschen. Dabei bleibt jede Änderung transparent und kann bei Bedarf auf eine vorherige Fassung der Seitenhistorie zurückgesetzt werden.

(c) K15t Software

(c) K15t Software

Über Erweiterungen, sogenannte Add-ons, können in diesem Unternehmens-Wiki Entwurfsversionen und freigegebene Versionen für Inhalte definiert werden. So ermöglicht beispielsweise die Erweiterung Comala Workflows, den Seiten einen Status zuzuweisen. Oder mit Hilfe des Add-ons Scroll Versions lassen sich freigegebene Inhalte bei Bedarf sogar in einen separaten Wiki-Bereich publizieren, der auf Wunsch öffentlich zugänglich ist. Darüber hinaus verwaltet dieses Add-on auf Wunsch auch mehrere Versionen und Varianten der Dokumentationsinhalte in einem zentralen Autorenbereich.

Diese Vorgehensweise ist an die Versionsverwaltung von Quellcode in der Software-Entwicklung angelehnt, wo in Entwicklungszweigen und Releases gedacht wird. Zunehmend verfolgen aber auch Technische Redakteure anderer Branchen diesen Ansatz, um Dokumentation agil erstellen und bereitstellen zu können.

Wege, wie wir von unseren Lesern lernen können

Die zweite (und spannendere) Art des Feedbacks kommt von den Leserinnen und Lesern, also all denen, welche die bereitgestellte Dokumentation auch tatsächlich nutzen um etwas zu lernen und um ein bestimmtes Problem zu lösen. Um deren Rückmeldungen effizient einzuholen, führt praktisch kein Weg an einer Web-basierten Plattform vorbei. Als Technische Redakteure können wir hier Bewertungs- und Kommentarfunktionen sowie Web-Analysewerkzeuge zu unseren Gunsten einsetzen.

Bewertungsfunktion für hilfreiche Inhalte
Am Naheliegendsten ist wohl die Verwendung einer Bewertungsmöglichkeit für die Nutzer der Dokumentationsinhalte. Technische Redakteure können über die Summe der Bewertungen eine Aussage über die Nützlichkeit der dargebotenen Inhalte erhalten – etwa auf einer Skala von 1–5 Sternen. In Confluence gibt es hierzu das Rate Macro, welches diese Funktion bietet.

Kommentare und Diskussionen
Manche Leser würden ausführlicheres Feedback in Form von Kommentaren hinterlassen – wenn wir es ihnen erlauben. Fehlt etwas, ist eine Information veraltet oder irreführend? Unsere Nutzer möchten vielleicht weiterführende Fragen stellen oder haben sogar selbst Antworten und Problemlösungen gefunden, die sie mit anderen Nutzern teilen wollen. Dies bereichert in vielen Fällen die von uns Technischen Redakteuren bereitgestellten Dokumentationsinhalte erheblich.

Die PHP-Dokumentation gewinnt beispielsweise erheblichen Nutzwert durch sogenannte „User-contributed notes“, also von Nutzern beigesteuerte Anmerkungen.

(c) K15t Software

(c) K15t Software

Andererseits können Nutzerbeiträge in großer Zahl auch eine echte Herausforderung für Technische Redakteure darstellen. Beim Software-Hersteller Atlassian, der seine Produktdokumentation im öffentlichen Confluence-Wiki bereitstellt, zeigte sich kürzlich, dass sich nur rund 20 % der Kommentare auf den Hilfeseiten direkt auf die Inhalte bezogen – der größte Anteil beinhaltete Support-Anfragen, Funktionswünsche etc. Dies führte dazu, dass das kollaborationsbegeisterte australische Unternehmen sich dazu entschied, dort die Kommentarfunktion vorerst zu deaktivieren.

Der zugehörige Blogpost, in dem Atlassian diese Entscheidung ankündigte, zeigt uns aber auch, wie gut Nutzerkommentare funktionieren und welchen Mehrwert sie bieten können. Mehr als 60 Personen kommentierten den Beitrag und diskutierten ihre Bedenken und Ideen mit den Atlassian-Verantwortlichen, die nicht nur in den Kommentarspalten den Dialog suchten.
In manchen Fällen mögen Kommentare also zu viel des Guten sein, aber sie sind definitiv etwas Gutes!

Detaillierte Webseiten-Zugriffsanalysen
Der dritte Weg, um an Feedback zu kommen führt über die Erhebung von Nutzerdaten. Mittels Web-Analysewerkzeugen wie Google Analytics können wir Technischen Redakteure beispielsweise schnell herausfinden, wie viele Nutzer unsere Web-basierte Dokumentation nach bestimmten Stichwörtern durchsuchen und wie lange Besucher auf den einzelnen Seiten verweilen. Web-Analysewerkzeuge sind wohl der leiseste Weg, um mehr über das Verhalten unserer „Kunden“ zu lernen.

Fazit

Erfolgreiche Technische Kommunikation ist mehr als Technische Redaktion. Dabei kommt es in hohem Maß auf das Nutzerfeedback an, damit wir passgenaue Inhalte für unsere Leserschaft erstellen können und um deren Informationsbedarf gemäß ihrer Erwartungen zu decken. Der beste Weg dorthin führt über kollaborative Methoden, die wir sowohl im internen Review-Prozess als auch zum Einholen von Kundenfeedback anwenden.

Viele Organisationen haben ein Enterprise-Wikis als optimale Plattform identifiziert, die beide Aspekte in einem Web-basierten Kollaborationswerkzeug vereint. Wenn wir Nutzer beim Erstellen und Optimieren von Inhalten beteiligen, so erhalten wir viel mehr ist als die Summe der einzelnen Bestandteile. Das gilt nicht nur fürs Web 2.0 allgemein, sondern auch für Technische Dokumentation.

Und wenn wir Technischen Redakteure aufmerksam in unseren Feedback-Kanal hineinhören, dann können wir möglicherweise sogar das eine oder andere Lob darin finden … 😉

Dieser Beitrag ist der erste Teil einer Artikelreihe im englischsprachigen Blog von K15t Software. Im nächsten Teil werden dort Lösungen vorgestellt, wie sich kollaborative Hilfeplattformen im Web bereitstellen lassen, damit wir als Technische Redakteure unsere Dokumentation auf die nächste Stufe bringen können.

Ergänzung doctima: Die deutsche Seite von Atlassian Confluence findet sich unter  https://de.atlassian.com/software/confluence.

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.