Die wenigsten IT-Mitarbeiter zählen das Erstellen von Dokumentationen zu ihren Lieblingstätigkeiten – schließlich will man ja pfiffige Lösungen entwickeln und innovative Software erstellen statt sich mit „Schreibkram“ aufzuhalten. Gerade in Projektbereich gibt es eine – häufig als übertrieben empfundene  –  Dokumentationspflicht: Spezielle Methoden und die entsprechenden Prozesse erfordern das Ausfüllen bestimmter Dokumentvorlagen. So ist in der Regel der Verlauf eines Projektes gut dokumentiert, doch wie sieht es aus, wenn es in den produktiven Betrieb übergeht? Wenn nicht mehr die IT-Fachleute damit umgehen, sonder die Anwender?

Dieser Aspekt der Dokumentation wird meist vernachlässigt. Stattdessen scheuen viele Unternehmen den zusätzlichen Aufwand und hoffen, mit einigen Ad-hoc-Schulungen das nötige Wissen vermitteln zu können. Diese Haltung ist sehr verbreitet, da der Return-on-Investment für eine gute Anwenderdokumentation häufig nicht so augenfällig ist wie in anderen Projektbereichen.

Wirtschaftliche Vorteile und Nutzen

Daher ist es wichtig, sich die Vorteile und den Nutzen von technischen Dokumentationen vor Augen zu führen:

Vorteil 1: Schnelle Einarbeitung

Neue Mitarbeiter können mithilfe einer guten Dokumentation zeitsparend und effizient eingearbeitet werden. Schnell einmal nachzusehen, wie etwas funktioniert, ist meist komfortabler als zu warten, bis ein erfahrener Kollege Zeit hat. So muss man nicht eine weitere Person zur Einarbeitung langfristig abstellen, sondern kann Fragen kompakt abarbeiten. Eine gute Dokumentation bietet hier also einen doppelten Vorteil: Schnelle Einarbeitung des neuen Mitarbeiters und weniger Zeitaufwand beim Unterweiser.

Vorteil 2: Rasche Erweiterung von Kapazitäten

Manchmal ist es notwendig, Kapazitäten rasch zu erweitern. Auch hier nützt eine gute Dokumentation – denn sie hilft, Aufwände und Kosten genauer abzuschätzen und Aufgaben schnell und reibungslos zu übergeben. So können auch größere Personengruppen rasch in einen Ablauf eingebunden werden.

Vorteil 3: Hohe Anwenderzufriedenheit

Kunden und Anwender arbeiten produktiver, wenn die Dokumentationen auf die speziellen Bedürfnisse der jeweiligen Zielgruppe abgestimmt sind und sich an ihrem Erwartungs- und Erfahrungshorizont orientieren. Sind in einem Unternehmen unterschiedliche Supportgruppen – zum Beispiel Service Desk und Onsite-Support – tätig, so können auch hier angepasste Dokumentationen die Effizienz steigern, da Informationen schneller und einfacher verfügbar sind. Und schnelle Hilfe bedeutet zufriedene Kunden.

Vorteil 4: Nachhaltiges Wissensmanagement

In vielen Unternehmen werden Kleinigkeiten über mehrere Abteilungen hinweg mehrfach dokumentiert: Informationen liegen in Wikis, Blogs, Dateien und anderen Plattformen verstreut. Um einen effektiven Wissensaustausch zu ermöglichen, muss dieses Wissen gesammelt und konsolidiert werden. Hierbei kann man auf die „Schwarm-Intelligenz“ setzten: Jeder dokumentiert nur die Aspekte, die in seinen Verantwortlichkeitsbereich fallen und eine zentrale Stelle koordiniert die Dokumentationen und macht sie allen zugänglich. So kann wertvolles Wissen für ein nachhaltiges Wissensmanagement genutzt werden.

Effiziente Erstellung von Dokumentationen

Damit sich der Aufwand für eine optimale Dokumentation möglichst schnell amortisiert, sollten Sie folgende Richtlinien beherzigen:

Nutzen Sie Vorhandenes

Machen Sie eine Bestandsaufnahme der existierenden Dokumentation einschließlich der Projektdokumente. Meist sind gute Grundlagen vorhanden, die es zu strukturieren und auf ihre Wiederverwendbarkeit und auf Textwiederholungen hin zu untersuchen gilt.

Schaffen Sie Standards

Standardisierte Formatvorlagen für das jeweilige Textverarbeitungssystem sorgen für ein einheitliches Erscheinungsbild und ermöglichen es den Autoren, sich auf die Erstellung der Texte zu konzentrieren.  Ein Redaktionsleitfaden sorgt für die durchgängige Anwendung der Vorlagen. Darüber hinaus soll er sicher stellen, dass Begrifflichkeiten, Abkürzungen und Fachausdrücke einheitlich verwendet werden. Soll die Dokumentation später in andere Sprachen übersetzt werden, so sollte man dies bereits jetzt berücksichtigen.

Holen Sie alle ins Boot

Der Redaktionsleitfaden beschreibt  auch die notwendigen Rollen der an der Dokumentation beteiligten Mitarbeiter. Machen Sie Ihr Anliegen publik und holen Sie alle Beteiligten rechtzeitig mit ins Boot – zum Beispiel den Service Desk, um die speziellen Anforderungen und Wünsche dieser Gruppe an eine angepasste Dokumentation aufzunehmen. Wenn Sie dieses Thema ausführlich betrachten wollen, führen Sie eine klassische Stakeholder-Analyse durch (siehe dazu den Artikel "Stakeholder-Analyse: Sieben Schritte zum besseren Anwendersupport").

Setzen Sie professionelle Software ein

Ein geeignetes Redaktionssystem erleichtert die Zusammenarbeit aller Beteiligten und sorgt für konsistente Inhalte. Der Aufwand für die Einführung eines solchen Systems macht sich meist schon nach kurzer Zeit bezahlt und sorgt für hochwertige Dokumentationen.

Mit diesen Tipps profitieren Sie von den Techniken, welche die erfolgreichsten Unternehmen für die Erstellung von Montageanleitungen, Gebrauchsanweisungen und Benutzerhandbüchern einsetzen. Wir von solveno unterstützen Sie gerne bei Ihrer Planung und Umsetzung – von der Auswahl eines Redaktionssystems bis hin zur kompletten Erstellung der Dokumentation.