Dokumentation als Nachhaltigkeitsmaßnahme

Die energieintensivste Form der Wiederverwendung ist die Neuentwicklung. Wenn niemand mehr versteht, was eine bestehende Komponente tut, wird sie nachgebaut. Danach existieren zwei Varianten im Projekt: Beide werden ausgeliefert, weil sich niemand traut, die alte zu entfernen, beide werden gewartet, beide landen im Bundle, das jeder Besucher überträgt. Aus fehlenden fünf Zeilen Kommentar werden so 30 KB dauerhafter Ballast. Guideline 2.7 klingt nach Projektbürokratie, beschreibt aber einen der wenigen Hebel, die nach dem Launch noch wirken.

Info

Die drei Erfolgskriterien von Guideline 2.7

Wiederverwendbarkeit der Ergebnisse: Erstelle Dokumentation und andere Arbeitsergebnisse in wiederverwendbaren Formaten, um doppelte Arbeit zu vermeiden und langfristige Nachhaltigkeit zu unterstützen.

Dokumentation der Ergebnisse: Dokumentiere Funktionsweise und technische Anforderungen in klaren und leicht pflegbaren Unterlagen. Halte die Dokumentation über die Zeit aktuell und gib Hinweise dazu, wie veraltete Informationen ersetzt oder ausgemustert werden.

Lesbarkeit der Ergebnisse: Gib Entwicklern Zugang zum Quelltext und zu Code-Kommentaren, damit sie den Code leicht verstehen, pflegen und wiederverwenden können.

Meine Einordnung

Der Zusammenhang zwischen Dokumentation und Emissionen ist indirekt, aber er ist real. Er läuft über die Lebensdauer. Eine Website, die verstanden wird, wird gepflegt. Eine Website, die niemand mehr durchdringt, wird irgendwann komplett neu gebaut. Ein Relaunch ist die teuerste Maßnahme im gesamten Lebenszyklus: neue Entwicklung, neue Tests, Migration aller Inhalte, meist neue Infrastruktur, oft neue Hardware bei den Beteiligten. Wer die Zeit bis zum nächsten Relaunch von vier auf acht Jahre verdoppelt, halbiert diesen Aufwand pro Jahr. Das schafft keine Bildoptimierung.

Das erste Kriterium nennt wiederverwendbare Formate. In der Praxis heißt das offene Formate. Eine Spezifikation, die nur in einem Design-Werkzeug mit laufendem Abonnement lesbar ist, ist genau so lange verfügbar wie das Abonnement. Markdown, CSV, JSON und schlichtes HTML lassen sich in dreißig Jahren noch öffnen, und sie lassen sich mit Bordmitteln durchsuchen, versionieren und automatisiert weiterverarbeiten. Ich schreibe deshalb auch die Anleitungen zu meinen eigenen Werkzeugen als einfache Dokumente, obwohl ich der einzige Nutzer bin. Der einzige Nutzer bin ich nämlich nur heute.

Das dritte Kriterium ist eine kleine Kampfansage an einen Teil der modernen Frontend-Entwicklung. „Zugang zum Quelltext“ bedeutet im Web wörtlich: Wer die Seitenquelle öffnet, soll etwas erkennen können. Bei einem serverseitig oder statisch erzeugten Dokument steht dort lesbares HTML mit Überschriften, Listen und Links. Bei einer Anwendung, die ihren Inhalt erst im Browser zusammensetzt, steht dort ein leeres Element und ein minifiziertes Bündel. Beides funktioniert, aber nur eines davon kann jemand verstehen, reparieren oder in zehn Jahren übernehmen.

Wo ich weiter gehe

Die Guideline verlangt, Dokumentation aktuell zu halten und veraltete Informationen auszumustern. Dieser Satz ist neu gegenüber älteren Fassungen, und er ist der wichtigste der ganzen Regel.

Achtung
Falsche Dokumentation ist schädlicher als gar keine. Wer keine hat, liest den Code. Wer eine veraltete hat, glaubt ihr zuerst, handelt danach, sucht anschließend den Fehler an der falschen Stelle und baut im Zweifel eine zweite Lösung neben die bestehende. Setze deshalb in jede Datei ein Datum der letzten Prüfung und behandle Dokumentation wie Daten: mit einer Aufbewahrungsfrist.

Damit gilt für Dokumentation exakt dieselbe Logik wie für Logfiles und Analytics-Rohdaten: Bestände, die niemand pflegt, werden nicht harmlos, sondern gefährlich. Datenhygiene ist keine Eigenschaft von Datenbanken, sondern eine Arbeitsweise.

Und es gibt einen Adressaten, den die Guideline noch nicht kennt. Verständlichkeit richtet sich inzwischen nicht mehr nur an Menschen. Systeme, die Inhalte automatisiert auswerten, lesen dieselben Signale: semantisches HTML, saubere Überschriftenhierarchie, strukturierte Daten. Eine Seite, deren Quelltext ein Mensch versteht, verstehen auch Maschinen. Und sie brauchen dafür weniger Anläufe, weniger Abrufe und weniger Rechenleistung als bei einer Seite, die ihre Bedeutung erst im Browser entstehen lässt. Lesbarkeit ist damit vom Höflichkeitsmerkmal zum Effizienzfaktor geworden.

Dein erster Schritt heute

Du brauchst kein Wiki. Du brauchst eine Textdatei neben jedem Ding, das Du selbst gebaut hast.

Tipp
Leg für Dein wichtigstes eigenes Werkzeug, Skript oder Template eine README-Datei an und beantworte darin fünf Fragen: Wozu ist das da? Was geht rein? Was kommt raus? Wovon hängt es ab? Wann habe ich es zuletzt geprüft? Das letzte Feld ist das entscheidende, denn es macht Veralterung sichtbar, ohne dass jemand suchen muss.

Wenn Du danach noch Lust hast: Öffne die Seitenquelle Deiner Startseite und lies die ersten dreißig Zeilen. Wenn Du dort nicht erkennst, worum es auf der Seite geht, erkennt es auch sonst niemand.

Wiederverwendung ist die einzige Optimierung, die rückwirkend wirkt: Sie spart die Arbeit, die schon einmal getan wurde.

Quelle: W3C-Fassung von Guideline 2.7