Von Pyramiden und (nicht vorhandener) Dokumentation

Im Alltag erlebt man es als Entwickler immer wieder: keine Dokumentation verfügbar. Das hat viele Auswirkungen – die meisten davon negativer Natur.

Lesezeit: 4 Min.
In Pocket speichern
vorlesen Druckansicht Kommentare lesen 172 Beiträge

(Bild: WitR/Shutterstock.com)

Von
Inhaltsverzeichnis

Als Cäsar Ägypten besuchte und Kleopatra kennenlernte, waren die Pyramiden bereits über 2000 Jahre alt. Man stelle sich die folgende Unterhaltung zwischen beiden vor. Im Hintergrund die mächtigen Pyramiden, der Himmel tiefblau, die Luft noch frisch. Kurz, ein wunderschöner Morgen im alten Ägypten.

Cäsar: "Beeindruckende Bauwerke. Von wem und wofür wurden die gebaut?"

Kleopatra: "Das weiß ich nicht. Auf jeden Fall entstanden sie vor meiner Geburt."

Cäsar: "Der Bau wurde bestimmt dokumentiert. Ohne Dokumentation können solche Bauwerke nicht entstehen. Das ist viel zu kompliziert. Wo befindet sich euer Langzeitarchiv?"

Kleopatra: "Wir haben eine Bibliothek in Alexandria. Wenn dich die Dokumentation so sehr interessiert, dann sollten wir dort suchen. Alternativ könnten wir auch eine romantische Bootsfahrt auf dem Nil machen?"

Also begeben sich die beiden nach Alexandria, kommen spät am Abend an und beginnen sofort, in der Bibliothek nach Aufzeichnungen zum Bau der Pyramiden zu suchen. Leider finden sie nichts. Es gibt tausende Schriftrollen. Das Ordnungssystem wurde über die Jahre mehrfach geändert und nur lückenhaft auf den Bestand an Aufzeichnungen angewendet. Die Suche bleibt erfolglos.

Allerdings stellt sich Cäsar mit der Fackel "etwas" ungeschickt an und das Unglück nimmt seinen Lauf. Der Rest ist Geschichte, die Bibliothek brennt ab. Falls es dort eine Dokumentation zum Bau der Pyramiden gab, ist sie für immer verloren. Was nun?

Wie in vielen anderen fiktiven Geschichten wurde auch hier Bezug auf bekannte Personen, Ereignisse und Bauwerke genommen. Der Einstieg für die Leser ist so auf jeden Fall unterhaltsamer. Der Zugang zum Grundthema hoffentlich auch. Man kennt das von der Geschichte um das trojanische Pferd. Sobald diese besondere Sorte "Pferd" in einem Artikel genannt wird, hat man als Leser oder Leserin bereits ein Gefühl, worum es geht. Besonders dann, wenn es sich um einen IT-Artikel handelt.

An dieser Stelle geht es allerdings um Dokumentation. Das hat die Einleitung vielleicht recht offensichtlich unoffensichtlich verraten. Ein Thema, mit dem man in der IT ständig in Kontakt kommt. Egal ob als Anwender, Entwickler oder in einer anderen Rolle. Und egal, ob man eine Dokumentation liest oder schreibt, das Thema hat viele Facetten: von Zielsetzung, Zeitpunkt und Umfang über Gültigkeit, Zielgruppe und Kontext hin zu Struktur, Budget und Verfügbarkeit. Das alles wurde vermutlich schon tausendfach diskutiert.

Unstrittig dabei ist meist, dass man in bestimmten Situationen dokumentieren sollte. Strittig wiederum die Festlegung der Situationen. Dabei sollte die Dokumentation der jeweiligen Situation und damit den Anforderungen angemessen sein. Dazu kann es nach Erfahrung des Autors nicht die eine Art zu dokumentieren geben. Das liegt in der Natur der Sache. Oder gibt es genau eine Sprache, in der sich Menschen verständigen? Eine einzige Musik, zu der sie tanzen? Oder gar nur ein Nahrungsmittel, von dem sich alle ernähren? Ein Fehler in einer Software ist anders zu dokumentieren als eine Softwarearchitektur. Überraschend ist daher, dass manchmal nur eine einzige Dokumentationsvorlage existiert. Die muss auf alles passen ... oder passend gemacht werden.

Zurück zur Geschichte von Cäsar und Kleopatra. An diesem Beispiel lässt sich ein Aspekt von Dokumentation besonders schön veranschaulichen: die Verfügbarkeit. Deswegen wurde die Geschichte ja gewählt. Je länger eine Anwendung in Gebrauch ist, desto höher ist die Wahrscheinlichkeit, dass die zugehörige, separat erstellte und gelagerte Dokumentation nicht mehr verfügbar ist. Nicht ganz so überraschend mag da sein, dass damit einhergehend auch oft die dem Design zugrunde liegende Idee verloren geht. Denn Fehler sind zu beheben und neue Funktionen einzubauen. Das ist Wartung.

Entwickler sind sich oft (ganz wie Cäsar in der Geschichte) sicher, eine Dokumentation müsse vorhanden sein. Allerdings ist sie nicht auffindbar. Wahrscheinlich haben so schon viele in ihrem Leben etliche Stunden mit der Suche nach Dokumentation verbracht – wertvolle Zeit.

Wie geht man damit um? Ein Ausgangspunkt kann sein, was für Entwickler (noch) zugänglich ist: die Entwicklungsobjekte, bestehend aus Klassen, Datenbanktabellen und vielem mehr.

Ganz ähnlich wie mit den Pyramiden. Diese sind auch noch da und vermutlich noch auf lange Zeit – selbst wenn die Dokumentation dazu nicht mehr vorhanden ist. Also kann man an den Bauwerken die Antworten auf die Fragen suchen, die einen antreiben. Nachfolgend einige Vergleiche zwischen der Untersuchung von Pyramiden und der Untersuchung von Software.