Gute Dokumentation finde ich gut

Gute Dokumentation finde ich gut. Erst kürzlich habe ich mich wieder einmal mit MS-Excel beschäftigt. Werte aus unterschiedlichen Dateien und darin beinhalteten Tabellen sollten zusammengestellt, bearbeitet und die daraus gewonnenen Erkenntnisse in einer ersten Übersicht grafisch aufbereitet werden.

Es ist schon beeindruckend, was einem dieses Standardwerkzeug mit weltweitem Verbreitungsgrad alles an Möglichkeiten bietet.

Allerdings bringt mich bei aller Begeisterung für das Werkzeug an sich die offizielle Dokumentation gerne zur Verzweiflung.

Gute Dokumentationen müssen Lösungen aufzeigen

Es ist nicht so, dass die existenten Befehle nicht super beschrieben wären und durch praktische Beispiele deren Anwendung recht schnell klar ist. Es ist vielmehr so, dass ich die relevanten Befehle nicht so einfach finde.

Grund dafür ist meine Suche, die Lösungen für Aufgaben- und Problemstellungen sucht und als Ergebnis den Vorschlag potentiell anwendbarer Befehle erwartet. Eine Dokumentation, die schöne Lösungen beschreibt und mir damit die Möglichkeit gibt, passende Probleme dafür zu finden, hilft  eben nur sehr bedingt.

Grundregel der menschlichen Kommunikation: Der Empfänger entscheidet, ob und wie eine Botschaft ankommt

Dafür muss sich der Schreiber in den Anwender hineinversetzen

Mir ist bewusst, dass es Dokumentationsnotwendigkeiten gibt, bei denen man keinen direkten Einfluss auf deren Art und Umfang hat. Auch ist klar, nicht alle Suchmuster und Fragestellungen potentieller Anwender abdecken zu können.

Dennoch gibt es aus meiner Sicht einen großen Nutzen für Dokumentation, wenn sich diese nicht am Schreiber, sondern am Leser und Anwender orientiert.

In der Kürze liegt die Würze

Was bringt mir eine „tonnenschwere“ Dokumentation die jeden potentiellen Anwender abschreckt, da er sich in ihr nicht zurecht findet. Was hilft es auf Seite 2.936 im Absatz 3 Schrägstrich 4 nachweisen zu können, dass es aufgeschrieben ist, wenn der, der es beachten soll nicht zum Lesen dieser Stelle gelangen kann.

Sagt ein Bild manchmal mehr als ein Roman voll prosa? Hilft eine mindmap mehr als ein ausformuliertes Protokoll?

Setzt man sich bei der Erstellung und Bereitstellung einer Dokumentation mit den nachfolgenden Fragen so auseinander, dass man zufriedenstellende Antworten findet, ist viel erreicht und Dokumentation nicht nur Kostentreiber, sondern auch Nutzenstifter.

• Wofür werden Anwender die Dokumentation verwenden? Wie werden sie diese Dokumentation anwenden bzw. mit welchen Strategien werden sie darin suchen um zu finden?
• Wird Ihnen das, was sie dann finden, ausreichende Antworten auf die Fragen aus der Suche geben?

Gerade in der heutigen Zeit, in der Veränderungen mit rasender Geschwindigkeit stattfinden und Softwareanpassungen und deren Produktivsetzung agil (Agil ist nicht undokumentiert) und in kurzen Zeitintervallen erfolgen, muss Dokumentation kurz, prägnant und treffsicher Auskunft über das aktuelle „wie“ geben können.