Von VSS, STP und Acces-Switchen

[kettcar]

Hallo zusammen, :new

ich möchte hier noch nicht zuviel über mein Projekt preisgeben. Habe aber eine Frage.

Ich arbeite an einer redundanten Access-Switch/VSS Topologie.

In der Berufsschule wurde uns gesagt das ein Handbuch unbedingt mit Bestandteil des Projektes werden muss. Wie umfangreich muss das denn für eine Arbeit aus dem Netzwerkbereich werden und in welchen Punkten unterscheidet sich der Inhalt von dem der Dokumentation?

Bin grad etwas verwirrt und hoffe auf Hilfe.

Greetz

kett

argl, bitte ein Mod Typo Überschrift^^

[euro]

In deiner Doku beschreibst du, was du gemacht hast.

Im Handbuch schreibst du, was man an der fertigen Lösung noch modifizieren kann bzw wen man schlagen darf, wenn nix mehr geht :-)

Wichtig ist in der Doku, dass du nix "verschönerst" ... wenn du im Projekt Probleme hast, dann schildere sie und zeige, wie du sie gelöst hast. Bringt normalerweise Extrapunkte.

[kettcar]

Ok, ich dachte in das Handbuch müssen nochmal explizit die genauen Konfigurationen der Schnittstellen, des Cores etc. Also eine fachlastigere Anleitung für nachkommende Netzwerkadministratoren die sich nicht die ganze Projektarbeit durchlesen wollen. Bis jetzt gabs auch wirklich keine Probleme bis auf die Terminplanung der Downtime mit den betroffenen Abteilungen.

Wäre schön da etwas Licht ins Dunkel zu bringen.

Noch ne Frage: 10 Seiten Text in der Dokumentation ohne Bilder und Tabellen? Zählen CLI-Befehle auch zum Text?

[euro]

die Anzahl der Seiten ist regional (=abhängig von der jeweils zuständigen lokalen IHK) unterschiedlich, in München und Umgebung sind meines Wissens bis 15 Seiten erlaubt. Dazu noch ein paar Seiten Anhang ... erkundige dich bei deiner lokalen IHK oder bei einem der hier vertretenen Prüfer aus deiner Region, da bekommst du verlässliche Infos her.

Das Handbuch würde ich, wenn es mehr als ein paar Seiten ist, nicht in die Doku packen, sondern den Prüfern im Vortrag geben.

Wichtig: in die Doku gehören weniger technische Spezifikationen, sondern dein Tun. Also "ich habe den Stecker in die Buchse gesteckt, vorher mich aber geerdet". Ins Handbuch gehört dann, dass der Stecker vom Typ XYZ sein muss. Ganz vereinfacht ausgedrückt ...

[kettcar]

Danke.

Ich werde jetzt meine Projektarbeit fertig schreiben und ein technisches Handbuch dazu anlegen. In dem steht wenig, aber technisches Zeug wie Konfig, LWL-Typen etc.

[Crash2001]

Die "komplette" projektrelevante Config gehört normalerweise einfach in den Anhang.

So gehst du dem Problem aus dem Weg, dass du zu wenig Seiten zur Verfügung hast und zudem kann so eine Config ja auch schon die eine oder andere Zeile enthalten. Dabei kannst du sie natürlich so kürzen, dass nciht die ganze Config, sondern nur relevante Befehle drin stehen, also nicht die Interfaces, die du z.B. gar nicht nutzt bei deinem Projekt, Access-Listen für andere Interface, Routing maps, die du für das, was du als Projekt machst nicht benötigst, etc.

Klar kannst du in der Doku oder im Handbuch auch noch einzelne Zeilen aus der Config als Beispiele o.ä. nutzen.

[kettcar]

Jo, die komplette Konfig nehme ich auch in den Anhang. Da wäre die des VSS1440, natürlich nicht komplett sondern nur die Port-Channel, und die Konfig des Testswitches 2960S. Hier habe ich die komplette, die ich aber noch projektrelevant zusammenstreiche. Auszüge aus den Konfigs habe ich jetzt sowohl in der Projektarbeits-Dokumentation(ca. 25-30 Seiten) sowie im Handbuch (sind 9 Seiten geworden). Das habe ich kurz und knapp zusammengeschrieben das ein folgender Admin die Arbeitsschritte nachvollziehen und aufgrund der erstellten Dokus weiterarbeiten kann.

Aufgrund der verwendeten Geräte reduzieren sich meine Links auf einen: Cisco Systems, Inc ^^

Insgesamt habe ich jetzt:

Projektarbeit Dokumentation (25 Seiten)

Projektarbeit Handbuch (9 Seiten)

Anlagen:

Konfiguration VSS1440

Konfiguration 2960S

Visio LWL-Plan Werksgelände

Visio Switchtopologie Werkshalle+RZ IST

Visio Switchtopologie Werkshalle+RZ SOLL

Port-Channel Zuweisung Ecxel-Tabelle

LWL-Verkabelungsplan Ecxel-Tabelle

Materialliste Porjektarbeit (? weil ist schon in der Doku)

reicht das im Umfang?

[Crash2001]

Da wir deine Doku und das Handbuch ja nicht kennen, und somit auch nciht wissen, was drin steht, wird dir wohl keiner sagen können, ob das ausreichend ist, oder ob nicht.

Gibt es von Seiten der für dich zuständigen IHK keine Beschränkung der Seiten für die Doku der Projektarbeit, oder bist du da noch drunter?

[kettcar]

Ein Dozent von uns, der auch im Prüfungsausschuss sitzt sagte mindestens 10 Seiten reinen Text in der Doku, Da bin ich wenn ich Visio, Excel und die Konfigausschnitte abziehe auch nah dran.

[Thalliana]

Normalerweise gibt es von der IHK recht strikte Vorgaben, die man normalerweise auch nicht all zu doll über- oder unterschreiten sollte (1-2 Seiten sind wohl okay). Bei uns waren das z.B 20 Seiten inkl. Anhang. Da wärst du ja schon weit drüber.

Normalerweise solltest du Infos dazu auf der HP deiner zuständigen IHK finden.

[kettcar]

Die HP der ihk-regensburg ist ja mal sowas von Panne^^

Kurze Frage noch: Als Anhang an die Projektarbeit:

Wenn ich Bilder (Visio-Zeichnungen& Screens) im Text verwende, muss ich die nochmal seperat anhängen?

Muss ich die Bilder/Grafiken im Text durchnummerieren ?

Und müssen die komplette Konfig usw. in den Anhang? Ich mein so eine Switchkonfig ist ja nicht kurz, ich müsste sie eh noch sicherheitsrelevant zusammenstreichen.

So kommem ich mindestens auchnochmal auf 10 Seiten(wenn nichtmehr) reinen Anhang o.O^^

[Thalliana]

Ja, Bilder im Text werden nummeriert und am Ende im Abbildungsverzeichnis aufgeführt. Da solltet ihr aber auch in der BS drüber reden...

Ich glaube nicht, dass es wichtig ist, die komplette Konfig im Anhang zu haben. Ich (bin FIAE) habe z.B. auch nur interessante Auszüge aus dem Quellcode mit in den Anhang aufgenommen, weil ich auf diese Stellen in der Präsentation (und auch in der Doku) näher eingegangen bin. Wenn man da zuviel anhängt, guckt sich das eh kein Schwein an^^.

[kettcar]

wird im Abbildungsverzeichnis nur die Nummer oder die Nummer + nochmal das Bild aufgeführt?

[Thalliana]

Nur die Nummer natürlich. Habt ihr da in der BS gar nichts drüber gelernt? Guck am besten einfach mal in den Downloadbereich, da gibt es ganz viele Dokumentationen als Beispiel, da bekommt man ein ganz gutes Gefühl dafür, was erwartet wird. Eine rojetdokumentation ist ja schließlich was ganz anderes als eine Produktdokumentation (mit er hab ich viel öfter zu tun^^).

[kettcar]

Ich habe ungefähr ein Dutzend Projektarbeiten hier die ich mir auch durchsehe. Ich werde es jetzt mit Beschreibung/Titel und Seitenanzahl im Anhangmachen, das dürfte reichen. Wie kommst du denn auf Produktinformation?

[Thalliana]

Naja, weil die meisten Dokus, die ich in meiner Ausbildung (und auch danach) halt eher Produktdokumentationen waren, von den Programmen, die ich geschrieben habe. Das war immer eher ne Beschreibung, wie das Programm zu bedienen ist, und was es alles kann. DArum fand ich es recht schwierig, in der Abschlussprüfung dann eine ganz andere Doku zu schreiben^^.