Use Case · Netzwerk-Dokumentation · MkDocs · NetBox
Die meisten IT-Dokumentationen sind veraltet, sobald sie fertig sind. Mit MkDocs als lesbarer Wissensbasis und NetBox als lebendigem Inventar entsteht eine Dokumentation, die mit Ihrer Infrastruktur wächst – statt hinter ihr herzuhinken.
Das Problem
Nicht das Fehlen von Dokumentation ist das Problem – sondern Dokumentation die niemand nutzt, weil sie niemand aktuell hält.
„Netzwerkdoku_final_v3_NEU.docx" liegt irgendwo auf einem Fileserver. Niemand weiß wo. Oder ob sie aktuell ist. Im Notfall – Kollege krank, neuer Techniker – sucht man blind.
Ein neuer Switch kommt ins Rack, ein Server bekommt eine neue IP, ein VLAN wird umstrukturiert – die Dokumentation erfährt es als letztes. Oder nie. Nach einem Jahr ist sie wertlos.
PDFs, Word-Dokumente, Excel-Tabellen, handgeschriebene Notizen – die Information ist irgendwo vorhanden, aber nicht in Sekunden auffindbar. Im Notfall kostet das Zeit.
Die Werkzeuge
MkDocs und NetBox ergänzen sich: MkDocs erklärt und beschreibt, NetBox inventarisiert und verwaltet. Zusammen ergibt das eine vollständige, lebendige Dokumentation.
Wissensbasis & Prozesse
Markdown-Dateien in einer klaren Ordnerstruktur – versioniert mit Git, gebaut zu einer schnellen statischen Website. Volltext-Suche, dunkles/helles Design, lesbar auf jedem Gerät.
Inventar & Netzwerktopologie
Das führende Open-Source-Tool für Netzwerk-Inventarisierung: IP-Adressen, VLANs, Geräte, Kabel, Racks, Standorte. Läuft als Docker-Container auf Ihrem Server.
Zusammenspiel
NetBox verwaltet die Fakten. MkDocs erklärt den Kontext. Zusammen entsteht eine Dokumentation die beides kann.
Alle Geräte, IPs, VLANs und Verbindungen werden in NetBox gepflegt. Jede Änderung an der Infrastruktur wird direkt hier eingetragen. NetBox ist die einzige Quelle der Wahrheit für Inventar-Daten.
MkDocs erklärt die Entscheidungen, Konfigurationen und Prozesse – mit Links zu den NetBox-Einträgen. „Warum gibt es dieses VLAN?" – in MkDocs steht die Antwort, in NetBox stehen die Details.
Alle Markdown-Dateien liegen in einem Git-Repository. Jede Änderung ist mit Autor, Datum und Kommentar nachvollziehbar. Kein versehentliches Überschreiben mehr.
Inhalt
Eine vollständige Netzwerk-Dokumentation deckt sechs Bereiche ab – von der physischen Infrastruktur bis zu den Notfall-Prozeduren.
Einblick
Markdown-Quelltext links – NetBox API-Antwort rechts. Einfach, lesbar, maschinenlesbar.
Einrichtung
Ich richte beide Systeme ein, erfasse die Bestandsinfrastruktur und übergebe eine fertige, gepflegte Dokumentation.
NetBox wird via Docker Compose auf einem vorhandenen Linux-Server oder VM installiert – mit PostgreSQL, Redis und einem Reverse Proxy.
Alle vorhandenen Geräte, IP-Adressen, VLANs und Verbindungen werden in NetBox eingetragen – entweder manuell oder per CSV-Import.
MkDocs wird lokal installiert, ein Git-Repository angelegt und die Ordnerstruktur aufgebaut. Die fertige statische Site wird auf dem Kundenserver deployed.
Die sechs Dokumentationsbereiche werden gemeinsam erarbeitet – ich schreibe den Rahmen, Sie füllen was nur Sie wissen können. Netzwerktopologie, Konfigurationen, Prozesse und Notfallpläne.
Eine Dokumentation ist nur so gut wie ihre Pflege. Ich zeige Ihnen wie Sie Änderungen selbst vornehmen können – und richte optional einen Update-Prozess ein, der sicherstellt dass die Doku aktuell bleibt.
Pakete
Einmalige Einrichtung und Erstbefüllung – danach können Sie selbst pflegen oder mich regelmäßig beauftragen.
Starter
790 €
Einmalig · optional 49 €/Monat Pflege
Professional
1.890 €
Einmalig · optional 89 €/Monat Pflege
Enterprise
ab 2.990 €
Einmalig · dann ab 129 €/Monat
Kontakt
Wenn die Antwort „irgendwo auf dem Fileserver" oder „im Kopf des Kollegen" lautet, ist es Zeit für ein Gespräch – kostenlos und unverbindlich.
mail@halle.systemsSven Eugen Halle · Informationssysteme · halle.systems