Agil und eXtrem - die Zukunft der Technischen Dokumentation

Immer mehr Stimmen werden laut, die den Sinn und Nutzen der Produktdokumentation in Frage stellen. Jüngste Artikel in Chip [1] und Spiegel Online [2] greifen das Thema auf und diskutieren es in der breiten Öffentlichkeit. Höchste Zeit also, dass auch wir uns damit befassen.

Hat Produktdokumentation ausgedient?

Vom Überraschungsei bis zur hochkomplexen Maschine kommt heute kaum ein Produkt ohne Dokumentation auf den Markt. Professionelle Produktdokumentation bietet viele Vorteile: Sie unterstützt die Nutzer, verringert den Schulungsaufwand, bietet rechtliche Sicherheit und entlastet den Kundenservice. Und es gibt sogar richtig gute Produktdokumentation, die auch die Konsumenten anspricht, so zum Beispiel die Dokumentation für die iPod®-Musikgeräte der Firma Apple. Selbst Jugendliche nutzen regelmäßig die kompakte Kurzübersicht und greifen hin und wieder zum Benutzerhandbuch. Also ist es offensichtlich gelungen, genau die Information zu liefern, die benötigt wird, und diese für die Nutzer auch noch ansprechend zu verpacken. Damit sind die zwei wichtigsten Kriterien zur Erstnutzung einer Dokumentation erfüllt:

Die gewünschte Information muss vorhanden und schnell auffindbar sein.
Die angebotene Information muss leicht verständlich sein.

Wenn dann auch noch das dritte wichtige Kriterium erfüllt ist, dass nämlich die gelieferte Information stimmt und weiterhilft, werden die Nutzer bei Bedarf immer wieder auf die Dokumentation zurückgreifen. Wehe aber, wenn die Dokumentation in einem der genannten Punkte versagt. Dann sind die Nutzer enttäuscht und geben lieber auf, bevor sie weitere Fehlversuche riskieren. Ein negatives Doku-Erlebnis demotiviert viele so nachhaltig, dass sie sich überhaupt nicht mehr mit Dokumentation abgeben mögen, weil sie es als Zeitverschwendung ansehen.

Das ist in der Branche sehr wohl bekannt, und so werden seit Jahren ungeheure Anstrengungen unternommen, die Nutzer gut zu versorgen. Es gibt eine Hochschulausbildung für Technikredakteure. Und auch die Gesetzgebung sorgt dafür, dass die Hersteller ihre Aufgabe ernst nehmen. Diese wiederum sehen sich in der Pflicht und nehmen erhebliche Kosten in Kauf.

Zusätzlich gibt es immer bessere technische Möglichkeiten, die eine Erstellung, Bereitstellung und Nutzung von Dokumentation erleichtern können. Oft aber zahlt sich all der Aufwand, der auf Erstellungsseite betrieben wird, auf der Nutzerseite nicht aus. Schauen wir uns unter diesem Aspekt die klassischen Publikationsformen Handbuch, Online-Hilfe und Online-Tutorial an.

Handbuch

Das gedruckte Handbuch ist immer noch eine beliebte Informationsquelle, sofern es einen nicht gleich mit seinem Umfang erschlägt und die Leser den Inhalt gut aufnehmen können - auch losgelöst vom Produkt. Aber wem nützen Hunderte von Seiten mit detaillierten Dialogbeschreibungen und Anleitungen, wenn sie losgelöst vom Produkt gelesen werden? Leider tendieren Handbücher immer noch dazu, in solch nutzloser Weise auszuarten. Im schlimmsten Falls werden sie mit nichtssagenden Formalien zusätzlich aufgebläht, zum Beispiel seitenlangen Einführungen oder Abbildungs- und Tabellenverzeichnissen. Kein Wunder, wenn das niemand lesen will. Viel zu lang würde es dauern, in diesem Wust das Gesuchte zu finden. Wie gut ein Handbuchkonzept auch immer sein mag, und wie viel Aufwand Autoren auch betreiben, um es liebevoll umzusetzen und seitenlang zu erläutern: kaum ein Leser ist geneigt, umfangreiche Abhandlungen zu lesen, nur um mit dem Handbuch korrekt umgehen zu können. Was sich nicht sofort erschließt, ist einfach zu aufwändig.

Online-Hilfe

Die Technik bietet heute zahlreiche Möglichkeiten, integrierte Detailinformation als Produktbestandteil mitzuliefern. Bei Softwareprodukten hat sich die Online-Hilfe etabliert, die direkt aus der Software aufgerufen werden kann. Nach fast 20 Jahren Online-Hilfe müssen wir aber immer noch feststellen, dass die Nutzer diese Informationsquelle nur selten nutzen. Hersteller, die jahrelang davon ausgingen, dass die Online-Hilfe der Dokumentationsteil ist, den die Kunden regelmäßig nutzen, haben in Usability-Studien feststellen müssen, dass die wenigsten Kunden überhaupt wissen bzw. wahrnehmen, dass es eine Online-Hilfe gibt, und kaum einer sie jemals nutzt. Das ist schockierend, bedenkt man, wie viel Aufwand in einer mehrsprachigen Online-Hilfe mit mehreren tausend Topics steckt, was die Pflege über Jahre an Kosten verschlingt und unter welchen Extrembedingungen die Redakteure Tag und Nacht arbeiten müssen, um die Online-Hilfe pünktlich zur Produktfreigabe fertigzustellen. Komfortable Zugriffsmöglichkeiten wie Inhaltsverzeichnis und Index werden kaum genutzt, weil die meisten Nutzer sich damit nie beschäftigt haben und auch nicht beschäftigen wollen. Der einzige akzeptierte Weg ist die Volltextsuche, die entweder keine oder zu viele Treffer liefert, sodass man die Online-Hilfe frustriert gleich wieder verlässt.

Online-Tutorial

Tutorials sind prima, wenn sie die zentralen Lerninhalte auch wirklich vermitteln: praxisnah und authentisch. In der Regel aber sind die Tutorials viel zu simpel und langweilen die Nutzer. Zudem kostet es häufig zu viel Zeit, sich auf diese Weise Produktkenntnisse anzueignen. Die Option, nach eigenem Tempo und Interesse vorzugehen, wird - wenn überhaupt - nur äußerst begrenzt angeboten. So gilt auch für Online-Tutorials: Der Erstellungsaufwand steht in keinem Verhältnis zum tatsächlichen Nutzen.

Wie kann es weitergehen?

Auf Dokumentation können wir (noch lange) nicht verzichten, denn immer noch sind unsere Produkte bei Weitem nicht selbsterklärend. Ganz im Gegenteil: Vieles wird immer komplexer. Selbst einfache Geräte wie Telefon oder Waschmaschine haben heute ein interessantes Innenleben, was sich dem Nutzer nicht sogleich erschließt.

Folglich müssen wir auf der Doku-Seite umdenken und nach neuen Methoden und Techniken Ausschau halten. Und wir werden erkennen, dass es in anderen Bereichen ähnlich ist. So erfindet beispielsweise die Softwareentwicklung immer wieder neue Methoden, um besser mit veränderten Bedingungen und Anforderungen umgehen zu können.

Methodik: Lernen von der Softwareentwicklung

eXtreme Programming (XP) ist eine innovative Entwicklungsmethode. „Extrem" bedeutet in diesem Zusammenhang, bewährte Praktiken wie zum Beispiel das Testen von Softwarekomponenten so weit wie möglich zu intensivieren und zugleich komplett auf unnötigen Ballast zu verzichten.

Seit etwa zehn Jahren ist XP erfolgreich im Einsatz. Zu den geistigen Vätern zählen Kent Beck, Ron Jeffries und Ward Cunningham, dem wir auch die Wikis verdanken. Erklärtes Ziel ist die effiziente Entwicklung hochwertiger Software innerhalb enger Zeit- und Kostenrahmen. Daher verzichtet XP auf eine Reihe belastender Dinge aus der klassischen Softwareentwicklung wie Lasten- und Pflichtenhefte, Spezifikationen usw. Im Vordergrund steht die eigentliche Arbeit: das Programmieren. Analyse und Entwurf sind in die Konstruktionsarbeiten integriert. Ausgiebige Tests in jeder Projektphase ersetzen die fehlenden Spezifikationen. Durch diese testgetriebene Entwicklung lassen sich auch große Softwaresysteme flexibel ändern und umstrukturieren. Der Arbeitsprozess im Projektteam orientiert sich ausschließlich am Ziel und wird fortwährend in sich verbessert. Das Team reagiert agil auf veränderte Anforderungen und neue Erkenntnisse. Und der Projektstand ist jederzeit durch funktionsfähige Softwareversionen dokumentiert.

Kollaborative Umgebungen

Entwickeln im Team steht bei XP im Vordergrund, getreu dem Motto: Vier Augen sehen mehr als zwei. Selbst weit verteilte Teams haben heute ausreichende Möglichkeiten, zusammenzuarbeiten. Wikis und Foren sind Beispiele dafür, wie Wissen ohne großen Aufwand zeitnah, effektiv und weltweit ausgetauscht werden kann.

Gute Aussichten für XD

Die Ideen und Ansätze von XP erzeugen eine effiziente und kreative Projektkultur, die auch in die Dokumentationswelt Eingang finden kann. Übernehmen wir die Kernprinzipien Feedback, Einfachheit und Kommunikation, können wir daraus mühelos die Methode des eXtreme Dokumentierens (XD) ableiten.

Feedback

Auf Feedback sind wir in der Dokumentation zwar schon eingestellt, allerdings finden herkömmliche Reviews zu selten statt und nicht unbedingt mit den richtigen Personen. Viel zu spät werden andere in die Dokumentationsentwicklung einbezogen. Und immer noch bestimmen einige wenige die Inhalte, die angeblich für alle Nutzer interessant, wichtig und passend sein sollen. Das funktioniert nicht, wie die Praxis zeigt.

Neue Methoden sehen wesentlich mehr Beteiligte vor. Insbesondere die künftigen Nutzer der Dokumentation sollen sich in den Erstellungsprozess einklinken, denn sie sind die eigentlichen Wissensträger. Auf Grund ihrer Erfahrung sind sie viel eher in der Lage, die wirklich wichtigen Informationen zu liefern, während einsame Redakteure sich nur imaginär in die Nutzerwelt versetzen können.

Je früher und je mehr Wissen zusammenkommt, desto besser kann ein interessanter Wissenspool entstehen, der auch tatsächlich genutzt wird. Technikredakteure kommen trotzdem voll zum Zug. Denn je mehr Personen involviert sind, desto mehr bedarf es einer Koordination und Steuerung. Dafür sind Technikredakteure prädestiniert, weil sie die Standards kennen, die professionellen Tools beherrschen und Erfahrung in der Dokumentationsverwaltung mitbringen.

Einfachheit

Einfache Dokumentationslösungen sind schneller zu erstellen, leichter zu verstehen und besser zu kommunizieren. Die Chance, mehr und besseres Feedback zu bekommen, ist groß. Und da einfache Lösungen auch leichter änderbar sind, lässt sich konstruktives Feedback flexibel integrieren.

Um diese Vorteile nutzen zu können, müssen wir noch mehr darauf achten, Informationen in überschaubare, in sich geschlossene Einheiten zu gliedern. Kleine Portionen werden lieber gelesen und kommentiert. Auch Mut zur Lücke ist gefragt. Galt bisher immer das hehre Ziel der Vollständigkeit, ist es sicher ratsam, bewusst auf Informationen zu verzichten, um höhere Qualität und größere Aufmerksamkeit für die wesentlichen Inhalte zu erzielen.

Kommunikation

Kommunikation ist für uns in der Dokumentation kein Fremdwort. Es gehört zu unserem Alltag, mit allen möglichen Stellen zu kommunizieren, insbesondere, um den erforderlichen Input zu erhalten. Aber oft hapert es mit der Kommunikation der Technikredakteure untereinander. Nach wie vor dominiert die Gepflogenheit, dass ganze Kapitel oder Dokumente von einer einzigen Person erstellt werden. Das muss sich ändern. Wir müssen lernen, selbst kleine Teile gemeinsam im Team zu erstellen. Das ist sicher ungewohnt und schwierig, aber lernbar.

Wo erfahren Sie mehr?

Besuchen Sie unser Single-Source-Forum am 18. Juni 2007 in München. Sie lernen Lösungen kennen, die heute schon Ansätze von agilem Dokumentieren verwirklichen, und Sie erleben Tools, die Sie bei der Umsetzung neuer Methoden bestens unterstützen.

Referenzen

Die in diesem Artikel zitierten Quellen und weitere Informationen zu diesem Thema finden Sie hier:

[1] Chip Editorial, Chip Nr. 3, März 2006

[2] Spiegel Online, 21. März 2006, 12:41

[3] Henning Wolf, Stefan Roock, Martin Lippert: Extreme Programming, dpunkt-verlag, Heidelberg 2005

[4] K. Beck: Extreme Programming Explained, Addison Wesley, 1999

[5] K. Beck and M. Fowler: Planning Extreme Programming Explained, Addison Wesley, 2001

[6] www.frankwestphal.de/Schlagwort-extremeprogramming.html

[7] c2.com/cgi/wiki?ExtremeProgrammingRoadmap

Informationen über Erfolg versprechende Ansätze erhalten Sie bei Comet: www.comet.de