🧪 Lab – noch kein Produkt

Netzwerkdokumentation ist immer veraltet. Außer sie schreibt sich selbst.

Ein Werkzeug, das die Dokumentation aus dem laufenden System erzeugt: PDF für die Ablage, Markdown fürs Repository, Draw.io-Diagramm für die Wand.

Problem

Die Doku ist fertig – und ab dem nächsten Tag falsch

Netzwerkdokumentation wird am Projektende geschrieben, weil sie im Abnahmeprotokoll steht. Danach pflegt sie niemand, weil sie von Hand gepflegt werden müsste.

  • Ein Word-Dokument, das seit der Übergabe nicht angefasst wurde
  • Diagramme, die einen Stand von vor zwei Umbauten zeigen
  • IP-Listen in einer Excel-Datei auf irgendeinem Laufwerk
  • Beim Störungsfall sucht man erst die Doku und traut ihr dann nicht
  • Der Nachfolger fängt bei null an

Roadmap

Wo diese Idee steht

Nichts davon ist gebaut. Der interessante Teil ist nicht das Erzeugen – das ist Fleißarbeit –, sondern dass die Dokumentation dem System hinterherwächst, ohne dass jemand daran denken muss.

In Arbeit

Gedacht

  • Controller auslesen (read-only)
  • Struktur, VLANs und Geräte erfassen
  • Export als PDF
  • Export als Markdown fürs Repository
  • Export als Draw.io-Diagramm
Geplant

Angedacht

  • Lebende Dokumentation: erkennt Änderungen und schreibt sie fort
  • Diff zwischen zwei Ständen – was hat sich seit wann geändert?
  • Automatischer Pull Request bei Änderungen am Netzwerk

Kennst du das Problem?

Wenn du ein Netzwerk betreust, dessen Dokumentation du selbst nicht mehr glaubst: schreib mir. Ich will wissen, welchen Teil der Doku du wirklich brauchst – nicht welchen das Abnahmeprotokoll fordert.