Die Herausforderungen der Software-Dokumentation meistern

So praktisch Software als Werkzeug ist: Gerade Experten-Software erzeugt einen enormen Informationsbedarf bei den Anwendern und zwar gleichermaßen bei IT-Administratoren wie Endbenutzern. Viele Konzepte und Verfahren müssen sie erst einmal erlernen, bevor sie sicher und effizient mit einer Software arbeiten können. So ist es kein Wunder, dass der Bedarf an guter Software-Dokumentation in Form von Handbüchern, Online-Hilfen, Tutorials, E-Learnings und vielen anderen Formen von instruktivem Content ungebremst groß ist. Perspektivisch wird im Bereich Software mit der weiterhin zunehmenden Digitalisierung der Arbeitswelt der Bedarf auch weiterhin steigen.

Was ist nun das Besondere an professioneller Software-Dokumentation? Wo liegen die Herausforderungen für Unternehmen, die dokumentationsintensive Software herstellen? Wie lässt sich Software möglichst effizient dokumentieren? Und zu guter Letzt: Was gehört eigentlich in eine Software-Dokumentation? Fragen, die wir uns heute einmal genauer ansehen.

Ein ganz typisches Charakteristikum von Software-Dokumentation ist die Vielfältigkeit der Themen und Zielgruppen. Machen wir uns das am besten anhand eines Beispiels deutlich: Nehmen wir ein IT-Unternehmen, das eine Software zur Steuerung von Produktionsprozessen anbietet. Was muss die Dokumentation alles abdecken?

Da gibt es zum einen die Anwender der Software. Weil man mit der Software aus unserem Beispiel aber nicht nur Prozesse steuern, sondern vor allem auch die Prozesslogik projektieren kann, haben wir schon einmal zwei sehr unterschiedliche Anwendergruppen: Anlagenbediener und Projektierer.

Daneben gibt es als dritte Zielgruppe die Administratoren der Software. Und weil man diese Software auch über eine API programmieren kann, als vierte Zielgruppe Software-Entwickler. Diese beiden Zielgruppen benötigen neben der klassischen IT-Dokumentation für die Programmierung auch nachvollziehbar kommentierten Code, in dem sich wichtige Funktionen, Methoden und Parameter direkt im Quelltext erkennen lassen.

Jede dieser Zielgruppen löst deshalb ganz unterschiedliche Aufgaben mithilfe der Software. Und so hat jede dieser Zielgruppen eigene Informationsbedarfe, die in der Dokumentation als Ganzem berücksichtigt werden müssen.

Das ist die klassische Ausgangssituation, die sich für jedes Software-Projekt- und Software-Unternehmen hinsichtlich der IT-Dokumentation ergibt. Hinzu kommen noch ein paar weitere Herausforderungen:

Blicken wir noch einmal auf die Inhalte der Dokumentation. Es macht für die Dokumentation einen großen Unterschied, ob nur eine Version eines Software-Produkts oder mehrere Versionen parallel dokumentiert werden müssen. Ein zusätzlicher Komplexitätsgrad entsteht, wenn die Software kundenindividuell konfigurierbar ist, und die Redaktion beim Erstellen der Dokumentation nicht weiß, mit welchem Leistungspaket die Anwender konkret arbeiten. Und natürlich ist der Übersetzungsbedarf ein wichtiger Faktor.

Eine zweite typische Herausforderung für Software-Dokumentation liegt im Bereich des Redaktionsprozesses. Software-Engineering bedeutet in vielen Unternehmen heute agile Methoden. Das ist für die Software-Entwicklung sicher eine gute Entscheidung, nur müssen in dem agilen Prozess-Design auch die Bedürfnisse der IT-Dokumentation systematisch berücksichtigt werden. Nur so ist sichergestellt, dass die Dokumentation einigermaßen zeitgleich mit der Software beim Kunden verfügbar ist.

Womit sich Unternehmen auf jeden Fall auseinandersetzen müssen, sind die sich stark verändernden Nutzererwartungen an Unterstützungsangebote. Gerade für Software-Anwender im professionellen Umfeld ist die digitale Informationsbeschaffung heute Standard. Sie wollen Detailinformationen einfach, schnell und problembezogen finden. Rein dokument-bezogene Ansätze, die diese Details in mehrere hundert Seiten langen PDF-Handbüchern “verstecken”, gehen an diesen Bedürfnissen systematisch vorbei. Der Bedarf nach konzentriertem und sofort verwertbarem Wissen spiegelt sich auch in der steigenden Relevanz von Instruktionsvideos wider. Und so ist es kein Wunder, dass die Technische Kommunikation reagiert und immer mehr Software-Anbieter Konzeptwissen oder einfache Abläufe als Bewegtbild aufbereiten.

Wie geht man als Software-Unternehmen am besten mit diesem Anforderungsbündel um? Wichtig ist es, nicht einfach irgendwo anzusetzen, sondern die Weiterentwicklung der Dokumentation gezielt vom IST-Zustand her zu steuern. Wenn Sie gerade vor dieser Herausforderung stehen, sollten Sie auf jeden Fall die folgenden drei Punkte in Ihrer Optimierungsstrategie berücksichtigen:

Welche Informationsmedien und -kanäle will Ihre Technische Redaktion Ihren Kunden zur Verfügung stellen? Und welche Inhalte wollen oder müssen Sie dort kommunizieren? Wenn wir noch einmal zu unserem Beispiel zurückkehren, könnte das Medienkonzept für das Software-Unternehmen so aussehen:

Als PDF werden nur noch Inhalte ausgeliefert, die aus rechtlichen Gründen in quasi gedruckter Form vorliegen müssen. Für die Zielgruppe Anlagenbediener und Software-Entwickler ist eine moderne, browser-basierte Hilfe im Format HTML5 die Hauptinformationsquelle. Einfache Abläufe werden darin als Schritt-für-Schritt-Anleitung erklärt. In der browserbasierten Hilfe können neben den klassischen Text- und Bildinhalten aber auch Videos angezeigt werden. Die Informationsstrukturen lassen sich mit modernen Darstellungsmitteln optimal gestalten. Weil der Content modular aufgebaut und intelligent verschlagwortet ist, können Anwender sehr gezielt auf spezielle Inhalte zugreifen.

Zusätzlich zur Hilfe gibt es eine webbasierte Knowledge-Base, auf die Anwender per Browser zugreifen können. Die Knowledge-Base ist auf Antworten zu Einzelfragen optimiert und setzt sich zum Teil aus den Hilfeinhalten, zum Teil aber auch aus Hilfsangeboten, die im Support entstehen, zusammen.

Mit Ausnahme der PDF-Dateien lassen sich alle Medien automatisch updaten. So ist gewährleistet, dass die Hauptinformationsquellen (in unserem Beispiel HTML5-Hilfe und Knowledge-Base) immer auf dem aktuellen Stand sind.

Wer im Unternehmen erstellt welche Informationen? Wie sind die Informatiker in der Entwicklung und die Technische Redaktion produktiv miteinander verzahnt? Welche Standards gelten für Text, Grafiken und Bewegtbild? Wie müssen Informationen verschlagwortet werden?

All das sind Fragen, die in den Bereich des Redaktionsprozesses fallen. Je mehr Kanäle Sie in Ihrem Medienkonzept definiert haben, desto wichtiger ist es, dass die Arbeitsprozesse reibungslos laufen.

Ein unentbehrlicher Helfer auf diesem Weg ist ein modernes Redaktionssystem. Mit einem Component Content Management System (CCMS) als Organisationszentrum können Sie zum einen flexibel die erforderlichen Kanäle aus einer Datenquelle bespielen. Zum anderen lassen sich ganz unterschiedliche Mitspieler in den Redaktionsprozess einbinden – von den Redakteuren über Projektmanager, Fachexperten (z. B. Entwickler) bis hin zu den Review-Verantwortlichen.