Was haltet ihr von meiner Einteilung der Dokumentation?

[Bruto]

Hey, ich bin gerade dabei meine Doku zu schreiben. Zuerst hatte ich mir ein Inhaltsverzeichnis erstellt, damit ich einen Leitfaden für mich habe. Nun habe ich schon mit den ersten 2 Punkten angefangen aber je mehr ich drüber nachdenke, desto unzufriedener werde ich mit der Aufteilung. Mögt ihr euch meine Einteilung vielleicht mal anschauen und Kritik dazu äußern?

Vorweg: Es geht um eine kleine Firma, die neu gegründet wurde und kompletten Support wünscht.

1. Einleitung

1.1 Arbeitgeberumfeld (Hier stelle ich meinen Betrieb und deren Aufgaben kurz vor)

1.2 Auftrag

1.3 Projektumfeld (Zuhause Doku, im Betrieb die Planung und beim Kunden die Durchführung)

1.4 Zeitliche Planung (Kreisdiagramm, vielleicht auf die ganze Seite oder doch nur ein Verweis auf den Anhang?)

2. Ist- und Soll Zustand

2.1 Ist Zustand

2.2 Soll Zustand

3. Planung (Was ich mir dabei gedacht habe, fällt mir gerade auch nicht mehr ein)

4. Ablaufplan (Detailliertere Zeitplanung. Kann vielleicht auch weg?)

5. Durchführung

5.1 Materialbeschaffung und Prüfung (TAE Dosen, Messgeräte, Kabel und Werkzeugüberprüfung)

5.2 Auswahl der Hardware (Für jeden Unterpunkt wollte ich die Vorteile einfach nur aufzählen)

5.2.1 Notebooks

5.2.2 Router

5.2.3 Telefon

5.2.4 Drucker

5.3 Schaltarbeiten (Grafiken zur TAE Beschaltung, Zwischenverteiler)

5.4 Montage und Konfiguration des Routers (Ein Bild wie die Kabel am Router angeschlossen werden, ein Bild von der Konfigurationsoberfläche)

5.5 Abweichungen (Kunde wollte weitere Geräte angeschlossen haben und die Telefone wurden nicht wie gewünscht geliefert)

6. Abschluss

6.1 Qualitätskontrolle

6.2 Kundeneinweisung (Sachen wie Router nicht vom Strom nehmen, Anrufe weiterleiten, andere Notebooks per Wlan in das Netzwerk einbinden,...)

7. Anhang (Glossar für spezielle Begriffe und Abkürzungen, Quellen, zu große Bilder, die ich nicht in die Doku bekomme)

Geht das so? Überfragt bin auch auch bei Punkt 5, ob das Anschließen und konfigurieren der Notebooks, der Telefone und des Wlan Druckers so wichtig ist.

[Slavefighter]

A: 1,4 In den Anhang

B: 3. Kannste mit 1,4 verbinden

C: 4. Kann auch in den Anhang

D: 5.1 sind sicherlich angebote, auch Anhang

C: 6.1.2 SOLL/IST Zustand wäre da noch gut

Das sieht aber nach verdammt vielen seiten aus und denk dran max. 10 Seiten für die Durchführung(+ Deckblatt und Inhaltsverzeichnis) = 12 Seiten

[Bruto]

Hey Slavefighter. Dann wird ja recht viel im Anhang landen. Ist es denn Sinnvoll zb. das Kreisdiagramm aus Punkt 1.4 in der Doku zu beschreiben und am Ende auf die Grafik im Anhang zu verweisen

Die Auswahl der Hardware hatte ich mir in etwa so vorgestellt: Die Wahl auf das HP Elitebook fiel, da es dank der XY Hardware genug Leistung für die nächsten Jahre bietet, die Tastatur einen leisen Anschlag bietet und HP 3 Jahre Vor Ort Garantie anbietet.

Also in den Anhang wollte ich einen Screen des Onlineshops mit den Spezifikationen legen und in der Doku wollte ich meine Auswahl begründen. Das ist doch ok oder?

Ok danke, werde ich mit einbeziehen.

Also ich mache mir eher Sorgen, dass es zu wenig Seiten werden. Die 10 Seiten, ohne Deckblatt und Inhaltsverzeichnis, sollen ja rein aus Text bestehen und da ich eher jemand bin, der sich kurz und knapp fast, wollte ich so viel wie möglich rein nehmen. Und eine genaue Schritt für Schritt Anleitung zur Verkabelung der PCs und der Routerkonfiguration, sind doch eher übertrieben.

[Slavefighter]

Ich sag mal so, meine Projektarbeit umfasst Genau 51 Seiten, 39 davon im Anhang

War ein WSUS ohne AD.

Da sind Angebote drin, Wirtschaftlichkeit ausgrechnet, Netzplan usw

und wenn du sachen aus dem Netz nimmst ( Software,Bilder etc) Mach am ende im Anhang eine Quell Liste, sons kanns ärger geben

Ich habe auch eine Auswahl gemacht mit den Angeboten und Softwarevergleichen, die hab ich in eine Tabelle gepackt und dann Kriterien dazu genommen, beispiel Leistung, Bedienbarkeit und danach bewertet. Das passt ganz gut auf eine halbe Seite.

Und was ich nur Empfehlen kann ist, wenn Fehler auftreten Dokumentier sie und für sie auf und wie deine Lösung dazu aussieht, dass kommt sehr gut an.

Vergiss um Gotteswillen die Wirtschaftlichkeit nicht, sprich Angebote vergleichen evtl ein wenig rechnen , Stromkosten könn als Nice to Have mit eingebaut werden.Das machen die meisten nicht, zeugt aber davon, dass man sich Gedanken gemacht

[Bruto]

Bei dir machte das aber wohl auch Sinn. Einen WSUS bekommen die Prüfer wohl nicht jeden Tag vorgelegt.

Stimmt, so ein Vergleich zwischen 2 unterschiedlichen Geräten ist interessanter und da könnte gleich die Stromrechnung mit einfließen. Danke

[Slavefighter]

Bei dir machte das aber wohl auch Sinn. Einen WSUS bekommen die Prüfer wohl nicht jeden Tag vorgelegt.

Stimmt, so ein Vergleich zwischen 2 unterschiedlichen Geräten ist interessanter und da könnte gleich die Stromrechnung mit einfließen. Danke

Ein WSUS wird ziemlich oft genommen, nur meiner ist halt standalone ohne Active Directory.

Antrag ging auch sofort ohne Probleme durch, war kein fake projekt und der Server rennt wie ne 1 :cool: