Netzwerkdokumentation - Wissensaustausch

  • Hallo Zusammen,


    da ich primär im Bereich von IT-Netzwerken (LAN/WAN) tätig bin, interessiert es mich, wie andere die Dokumentation der Systeme durchführen.


    Welche Philosophie verfolgt ihr? Bei einigen Firmen habe ich gesehen, dass einzig ein Layer 2/3 Plan erstellt wird, die Konfig abgelegt wird und das wars. Andere schreiben wiederum einen halben Roman.


    Wie seht ihr das? Was gehört in die Netzwerkdokumentation?

  • Ist jetzt vielleicht etwas blöd gesagt, aber wir erstellen unsere Dokumentation so, dass jeder, der das Netzwerk dort noch nie "in den Fingern" hatte, sich sofort anhand von ihr zurecht findet und zu 99% Bescheid weiss dann.

  • Ich orientiere mich etwas nach dem OSI-Modell bei der Dokumentation.


    1. Alles zur Hardware - Welche Komponenten werden eingesetzt, welche Firmware, Garantie, Hostname, etc.


    2. Eigentlich ein Layer 2 Plan - mit den Komponenten. Hausverkabelung muss mich soweit nicht interessieren, da der Elektriker diese Informationen eigentlich zur Hand haben sollte.


    3. Dokumentation über die implementierten Netze, Routing


    4. Dokumentation über das Management der Komponenten, wie IP, zugriffsrechte, etc.


    5. Dokumentation Port-Config (VLAN, MTU, was auch immer)


    6. Besonderes


    rovster, kannst du das vielleicht etwas genauer erläutern?

  • Du hast jetzt eigentlich fast alles selber erläutert...


    Nur kommen bei uns noch alle Users, Groups, Shares und ACL's in die Doku.
    Die ganzen Mails (falls POP-Beamer) kommen dazu, spez.
    Software von Kunden (Installation etc.).
    Dann DNS-Einträge beim Hoster.


    Mehr kommt mir gerade nicht in den Sinn...

  • Ich dokumentiere:


    - so wenig wie möglich, so viel wie nötig.



    Dubeli Doku nach Rovster mache ich nur auf unbedingten Kundenwunsch, es hat meistens seinen Grund, weshalb der Kunde eine Spezialisten eingekauft hat, um gewisse Sachen zu machen. Wenn dann die Putzfrau die Systeme betreut, läuft sicher etwas schief.

    Bremsen macht die Felge dreckig!
    Mitglied der PC4all Schlägertruppe!!!
    DutcheKa (04:41 PM) : aye, skipper ;)
    ...Weasel stopped DLS spamming-spree!
    "National sein heisst nicht, fremde Völker hassen, sondern das eigene Volk lieben." Peter Rosegger (1843 - 1918)
    Unbent, Unbowed, Unbroken! ©Hammerfall 2005 - Pain is temporary, Pride is forever ©? - ONE SHALL STAND. ONE SHALL FALL.©The Transformers 1984


    Meine Ricardo-Auktionen!

  • Was hat das mit Dubeli Doku zu tun, dass wenn ein anderer der das Netzwerk dort nicht kennt, jedoch vom Fach ist, es gleich zu verstehen hat?!


    Es ist absolut das schlimmste, wenn du zu einem Kunden kommst, bei dem du noch nie warst und weisst absolut nicht was Sache ist.


    Naja, ist halt schwer zu beurteilen, man müsste halt mal eine Doku des anderen sehen...
    Was ich jedoch bis jetzt gesehen habe, sah ähnlich aus wie unsere Dokus, nur eine war bis jetzt für die Putzfrau gestaltet, verstanden hab ich es aber nicht, auf Anfrage wusste der nette Herr selber nicht mehr mal was Sache ist.

  • Zitat

    Original von rovster
    Was hat das mit Dubeli Doku zu tun, dass wenn ein anderer der das Netzwerk dort nicht kennt, jedoch vom Fach ist, es gleich zu verstehen hat?!


    Es ist absolut das schlimmste, wenn du zu einem Kunden kommst, bei dem du noch nie warst und weisst absolut nicht was Sache ist.


    Naja, ist halt schwer zu beurteilen, man müsste halt mal eine Doku des anderen sehen...
    Was ich jedoch bis jetzt gesehen habe, sah ähnlich aus wie unsere Dokus, nur eine war bis jetzt für die Putzfrau gestaltet, verstanden hab ich es aber nicht, auf Anfrage wusste der nette Herr selber nicht mehr mal was Sache ist.


    Sorry, hab mich verlesen, irgendwie hab ich was von Putzfrau gelesen :gap


    Ich meinte damit levelgerecht dokumentieren. In einer Doku sollte nicht drinstehen müssen, was eine IP oder ein VLAN ist, sonst geht die Doku an das falsche Publikum.



    Ich möchte noch eine andere Frage aufwerfen; Wie habt ihr es mit Parameter? Ich dokumentiere nur die Parameter, die vom Default abweichen. Findet ihr das OK?
    Es geht mir dabei drum eine Doku schlank zu halten. Ich hatte mal einen Kunden, der hatte für 1 ESX Host und 3 Server (11 User) eine Doku von fast 400 Seiten. Der Aufwand dort was zu finden, was massiv höher als es am System rauszufinden.

    Bremsen macht die Felge dreckig!
    Mitglied der PC4all Schlägertruppe!!!
    DutcheKa (04:41 PM) : aye, skipper ;)
    ...Weasel stopped DLS spamming-spree!
    "National sein heisst nicht, fremde Völker hassen, sondern das eigene Volk lieben." Peter Rosegger (1843 - 1918)
    Unbent, Unbowed, Unbroken! ©Hammerfall 2005 - Pain is temporary, Pride is forever ©? - ONE SHALL STAND. ONE SHALL FALL.©The Transformers 1984


    Meine Ricardo-Auktionen!

  • Ja, wir machen das auch so, solange es default ist, wird nicht dokumentiert.
    Genau, das meinte ich mit der "für die Putzfrau gestaltete Doku", stand eigentlich alles drin, aber man konnte absolut nichts finden und einen Überblick verschaffen.


    Naja unsere Dokus sind zwischen 6 und 20 Seiten, je nach dem wie gross halt der Kunde ist.
    Aber eben, das reicht locker um alles nötige zu dokumentieren und man hat sehr schnell einen Überblick.


    Letzte Woche einen ESX Host mit 2 Server gemacht, für 10 User, Doku hat 8 Seiten, aber auch nur weil sie elend viele POP-Accounts haben.

  • Naja, also für richtig seriöse Implementationen mit AD, ESX, 120 VMs, Storage, Netzworking, Backup, etc. komme ich schon auf 120 Seiten. Aber grad Backup ist recht aufwendig, wenn du das sauber machen willst, vorallem aufwendig nachzuführen. Aber wär halt mühsam alles neu zu erarbeiten, wenn mal was kaputtgeht. Und in der Regel bezahlt der Kunde die Doku ja auch. Ich schaue, dass ich in ca. 10-20% der Zeit für die Doku habe.

    Bremsen macht die Felge dreckig!
    Mitglied der PC4all Schlägertruppe!!!
    DutcheKa (04:41 PM) : aye, skipper ;)
    ...Weasel stopped DLS spamming-spree!
    "National sein heisst nicht, fremde Völker hassen, sondern das eigene Volk lieben." Peter Rosegger (1843 - 1918)
    Unbent, Unbowed, Unbroken! ©Hammerfall 2005 - Pain is temporary, Pride is forever ©? - ONE SHALL STAND. ONE SHALL FALL.©The Transformers 1984


    Meine Ricardo-Auktionen!