pdoku_fisi Projektdoku - Konsolenbefehle

[Gast jonvirus]

Hallo Zusammen,

schreibe grad die Projektdoku für mein Abschlussprojekt (FiSi).

Eine meiner Hauptaufgaben ist die Konfiguration eines Extreme Networks Switches mit VLANs, ACLs und allem drum und dran.

Jetzt frag ich mich, wie ausführlich ich die einzelnen Konsolenbefehle beschreiben soll. Gehören die Befehle selber

 in die Doku oder nicht? Hier 3 Möglichkeiten:

1.

configure vlan Verwaltung add ports 1-14, 16, 19-23 untagged

Füge die Ports 1-14, 16 und 19-23 untagged zum VLAN "Verwaltung" hinzu. Die Ports wurden "untagged" hinzugefügt, da nur ein VLAN an die Ports zugewiesen wird.

 

Meiner Meinung nach schön übersichtlich, bläht die Doku aber stark auf, wenn ich allen Befehlen jeweils eine Zeile Platz gebe.

 

2.

Zum VLAN "Verwaltung" wurden die Ports 1-14, 16 und 19-23 untagged hinzugefügt. Die Zuweisung erfolgte "untagged", da nur ein einzelnes VLAN den Ports zugewiesen wird.

 

Spart am meisten Platz, enthält aber keinen Konsolenbefehl.

 

3.

Mit dem Befehl configure vlan Verwaltung add ports 1-14, 16, 19-23 untagged werden die genannten Ports untagged dem VLAN "Verwaltung" zugeordnet. Die Zuweisung erfolgte "untagged", da nur ein einzelnes VLAN den Ports zugewiesen wird.

 

Ist eine Mischung aus beidem. Gefällt mir momentan am besten.

 

Was sagt ihr dazu?

[arlegermi]

Ich halte Variante 3 auch für am besten. Es lohnt sich allerdings in der Doku selber meiner Meinung nach nur für essentielle Befehle. Ich kann das bei Netzwerkkonfiguration nicht einschätzen, aber ich würde nicht jedes "ls" oder "cd" mit aufnehmen (überspitzt gesagt).

Es kann allerdings sinnvoll sein, die gesamte Konfiguration im Anhang mitzuliefern.

[Gast jonvirus]

Gut, dann kombiniere ich am besten die Varianten 2&3, 2 nehme ich dann für die allgemeinen Sachen und 3 für die "besonderen".

 

Das ist eine gute Idee.