Inhaltsverzeichnis Projektdoku

[Julsche]

Hallo zusammen,

habe auch mal eine Frage zum Inhaltsverzeichnis. Kann ich es so lassen? Schnittstellen wegen Auftraggeber etc habe ich keine, da ich als Systemintegratorin nichts programmiere und daher keinen richtigen Kunden habe. Habe das bisher auch nur in Dokus von Anwendungsentwickerlern gesehen.

1. Einleitung 5

1.1 Übersicht Projektablauf 5

1.2 Betrieb 5

1.3 IT-Abteilung des Betriebes 5

2. Projektziel 5

2.1 Situation bei Projektbeginn 5

2.2 Ziel des Projekts 6

2.4 Umfang des Projekts 7

3. Projektplanung (Ressourcen- /Ablaufplanung) 7

3.1 Zeitplanung 7

3.1.1 Tabellarische Gliederung der Stunden 8

3.1.2 Meilensteine 8

3.2 Materialbedarf 8

3.3 Personalplanung 9

3.4 Kostenplanung 10

4. Durchführung des Projekts 10

4.1 Auswahl der Software 10

4.1.1 NetOp - Beschreibung 11

4.2 Auswahl der Hardware 12

4.3 Installation und Konfiguration des Servers 13

4.4 Installation und Konfiguration der Clients 14

4.5 Einrichten der Guest und Hostgruppen 14

4.6 Testen der Remoteverbindungen 15

5. Projektergebnis 17

5.1 Soll-Ist Vergleich 17

5.2 Übergabe und Einführung der Kollegen des IT-Bereichs 18

5.3 Fazit 18

Anhang A 19

Organigramm des Betriebes 19

Anhang B 20

Vergleichstest der einzelnen Remote Access Programme 20

Anhang C 21

Installationsanleitung für den NetOp Security Server 21

Anhang D 22

Konfiguration des NetOp Security Servers 22

Anhang E 23

Glossar 23

Gruss

Julsche

[NickiD]

HI!

Punkt 1.2 und 1.3 würde ich als ein Punkt nehmen. Die Seitenzahlen auch nicht gleich dahinter schreiben (schön in einer Flucht ).

[Sandrin]

Hi,

was ich bei dir vermisse ist die Ist-Analyse und das Sollkonzept. Innerhalb welchen Punktes in deinem Projekt machst du diese?

Ansonsten hört sich die Strukturierung meiner Meinung nach recht gut an.

[Julsche]

Unter 2. Projektziel habe ich einmal die Situation bei Projektbeginn und dann unter 2.2 Ziel des Projekts <<< hmmm..ist ja eigentlich die Soll und Istanalyse oder soll ich da lieber noch was dran ändern?

[Sandrin]

2. Projektziel 5

2.1 Situation bei Projektbeginn 5

2.2 Ziel des Projekts 6

Ich würde die Punkte etwas anders nennen, eventuell sogar in einen eigenen Hauptpunkt fassen.

2. Ist-Analyse

3. Soll-Konezpt

[timmi-bonn]

Original geschrieben von Julsche

4.6 Testen der Remoteverbindungen

Ist das alles an Test(s), was Du durchführst? Wo erstellst Du das Testkonzept? Was ist mit Integrationstest?

Schreibe besser einfach "Test-Phase" o.s.ä. Dann kannst Du das während des Projektes mit Inhalt füllen. Über das Testen selbst habe ich hier im Forum schon oft was geschrieben --> Such-Funktion.

gruß, timmi

[just_me]

Ich habe ehrlich gesagt keine Ahnung, wie die IHK derartige Dokumentationen bewertet, aber IMO ist diese Gliederung didaktisch falsch und der Schwerpunkt ist - versehentlich? - verschoben.

Es gibt dutzende Dokumentationen im I'net, wie ein derartiges Dokument aufzubauen ist.

Frei nach Balzert, Kotler und Microsoft sieht es also etwa so aus:

1 Prolog

2 Planungsphase

2.1 Auswahl der Software

2.2 Auswahl der Hardware

2.3 Materialbedarf

2.4 Personalplanung

2.5 Kostenplanung

3 Definitionsphase

3.1 IST

3.2 SOLL

3.2.1 Muss

3.2.2 Wunsch

3.2.3 Abgrenzung

4 Entwurfsphase

4.1 Use cases

4.2 Diagramme

4.3 Schnittstellen

5 Implementierungsphase

5.1 Installation und Konfiguration des Servers

5.2 Installation und Konfiguration der Clients

5.3 Einrichten der Guest und Hostgruppen

6 Abnahme- & Einführungsphase

6.1 Testen der Remoteverbindungen

6.2 Übergabe und Einführung der Kollegen des IT-Bereichs

7 Wartungs- & Pflegephase

7.1 Wartung

7.2 Pflege

8 Epilog

Anhang A, B, C, ...

Die Planungsphase kann zusammengestrichen werden, da das Projekt sicher nicht biblische Dimensionen annehmen wird, oder? Es ist also eher unwahrscheinlich, dass du zu jedem Punkt mehr als ein, zwei Sätze zu sagen hast.

Vorschlag:

2.1 Hard- & Software

2.2 Personal & Kosten

Der Punkt 3 bildet essentielle Auszüge aus dem Pflichtenheft und dem Lastenheft ab. Üblicherweise wird daher in technischen Dokumentationen rege auf diese verwiesen.

Im Punkt 3.1 und 3.2 werden Referenzen auf das Lastenheft gelegt. Die Unterpunkte 3.2.1-3.2.3 stellen Essenzen der relevanten Bereiche des Pflichtenheftes dar.

Zu 4. gehören alle use cases, Diagramme, Entwürfe, Pseudocodes etc. die dein Projekt theoretisch beschreiben. Erst in Phase 5 wird 'tätlich gearbeitet'.

Wenn die Punkte 5.1.-5.3. und 6.1. Bestandteil der Vorbereitungen sind, gehören sie in die Planungsphase 2.

Sollten sie Inhalt deines Projektes sein, gehören sie in die Phase 5 respektive - die Tests - in Phase 6.

Die Schnittstellen (neu: 4.3) stellen 'mögliche Verbingungen (explizite Verbingungen) zur Welt' dar. Diese können vielfältig sein. Daher ist es notwendig, darauf hinzuweisen, wie sie aussehen. (Selbst wenn keine vorgesehen sind, ist dies ein wichtiger und erwähnenswerter Punkt.)

Der SOLL-IST-Vergleich (alt: 5.1) ist Bestandteil des Fazits (alt: 5.3); gehört also logisch zum Punkt 8 (neu).

Was ist eigentlich "Übergabe und Einführung der Kollegen"? Das klingt ein bisschen makaber.

Summa summarum:

---------------

Alles in Allem stellt diese Gliederung EINE Möglichkeit dar, ein Projekt zu dokumentieren. Tatsächlich ist sie - zumindest in der Grobgliederung - quasi genormt, und wird weltweit in diesen Phasen beschrieben.

Ich habe - und ich wiederhole mich, da ich bereits mehrfach las, dass Subjektivität ein bevorzugtes Mittel der Prüfungskommissionen ist - keine Ahnung, wie die betreffende Prüfungsstelle es haben will, aber ICH würde es so fordern.

Grund: Ich will über den Verlauf des Projekts informiert werden, und keine redundanten Informationen erhalten, die ich ebenso aus Lastenheft, Pflichtenheft, technischer Dokumentation oder Benutzerdokumentation ziehen könnte.

[MBaeuml]

Sehr toll deine Struktur. Und nun verrate mir nur noch wie ich das in 10 Std Zeit die für die Doku sind schaffen soll

[timmi-bonn]

Original geschrieben von MBaeuml

Sehr toll deine Struktur. Und nun verrate mir nur noch wie ich das in 10 Std Zeit die für die Doku sind schaffen soll

Mühelos! Denn die eigentliche Arbeit ist das Strukturieren. Das Füllen der einzelnen Kapitel geht relativ schnell. ... Vorausgesetzt, man beherrscht sein Fachgebiet.

gruß, timmi

[Julsche]

Das glaube ich auch nicht, dass die bei der IHK da sooo einen Wert drauf legen, man kann auch viel "kaputt reden."

Denke, dass meine Gliederung garnicht so schlecht ist.

Danke nochmal Sandrin und NickiD

[CJW]

host schön gemacht doll oil

[just_me]

Natürlich kannst du es so lassen --- du kannst es auch ändern. Es ist deine Entscheidung.

Tatsache ist, dass derartige Dokumentationen mittlerweile "Quasi-Normen" unterliegen. Es ist also de facto keine Geschmackssache, wie so etwas auszusehen hat.

Realität ist auch, dass es keine absolute Norm gibt. Daher ist jede derartige Dokumentation eben doch "Geschmackssache". Dies gilt insbesondere, wenn Dokumentationen lediglich zum Selbstzweck verfasst werden.

Interessant finde ich nur

...habe auch mal eine Frage zum Inhaltsverzeichnis. Kann ich es so lassen?

und

Denke, dass meine Gliederung garnicht so schlecht ist.

Wolltest du jetzt hören: "Ja, super! Tolle Gliederung!"?

[timmi-bonn]

Original geschrieben von Julsche

Denke, dass meine Gliederung garnicht so schlecht ist.

Stimmt - ich kenne schlechtere. Aber das heißt ja nicht, daß man sie nicht mehr verbessern könnte.

gruß, timmi

[Nudel81]

Haste ganz toll gemacht... alt oil :bimei

[Julsche]

@Nudel, cjw

Ei aber allemo, wenn ihr des sacht *g*...ihr ahrisch dolle oile :-)

:OD