pdoku_fisi Dokumentation fast fertig, Fragen zum Aufbau

[Havok2333]

Hallo zusammen,

mittlerweile ist auch meine Projekt-Dokumentation ziemlich weit fortgeschritten. Eigentlch bin ich sogar fast fertig und überarbeite grade noch mal einige Passagen, mit denen ich noch unzufrieden bin. Ganz allgemein wollte ich euch fragen, ob der Aufbau der Doku soweit in Ordnung ist:

Inhaltsverzeichnis

 

1 Einleitung.......................................................................................................................... 2

 

1.1Projektbeschreibung................................................................................................... 2

 

1.2 Projektziel:................................................................................................................. 2

 

1.3 Projektumfeld:........................................................................................................... 2

 

1.4 Prozessschnittstellen:................................................................................................. 3

 

1.5 Projektabgrenzung:.................................................................................................... 3

 

1.6 Projektablauf:............................................................................................................ 3

 

1.7 Abweichungen vom Projektantrag.............................................................................. 3

 

2 Analyse............................................................................................................................. 3

 

2.1 Durchführung der Ist-Analyse..................................................................................... 3

 

2.2 Entwerfen des Soll-Konzeptes.................................................................................... 5

 

3 Planung............................................................................................................................ 5

 

3.1 Evaluierung von Software-Lösungen........................................................................... 5

 

3.2 Ressourcenplanung.................................................................................................... 6

 

3.2.1 Terminplanung:.................................................................................................... 6

 

3.2.2 Sachmittel-Planung.............................................................................................. 6

 

3.2.3 Personal-Planung................................................................................................. 7

 

3.2.4 Gesamt-Kostenplanung........................................................................................ 7

 

3.3 Kosten/Nutzen-Analyse............................................................................................. 7

 

4 Realisierung...................................................................................................................... 8

 

4.1 Beschaffung der Software.......................................................................................... 8

 

4.2 Erstellung der VM....................................................................................................... 8

 

4.3 Installation des Server-Betriebssystems...................................................................... 8

 

4.4 Installation und Konfiguration von OPSI....................................................................... 9

 

4.5 Server-Anbindung der Clients:.................................................................................. 10

 

5 Qualitätssicherung........................................................................................................... 10

 

6 Soll-Ist-Vergleich / Ausblick.............................................................................................. 10

 

7 Abnahme........................................................................................................................ 10

 

8 Dokumentation............................................................................................................... 10

 

Desweiteren hätte ich da noch eine inhaltliche Frage:

Die gesamte Dokumentation soll prozessorientiert erstellt werden. Wie genau / umfassend muss ich im Teil der Realisierung vorgehen? Ich habe zu jedem Schritt eine grobe Beschreibung der Aktivität abgegeben, wie z.B.:

4.4 Installation und Konfiguration von OPSI

 

Vor der eigentlichen Installation von OPSI müssen noch die OPSI- und EPEL-Repositories (Dieser Schritt wurde nicht in der Hersteller-Doku angegeben und musste mit ein wenig Recherche-Arbeit gelöst werden) in die Software-Paket-Verwaltung von Yum integriert werden. Anschließend werden die in der Hersteller-Dokumentation beschriebenen Befehle ausgeführt, um OPSI mit all seinen zur Ausführung benötigten Programmen und Bibliotheken im Verzeichnis /var/lib/opsi zu installieren. Für den Fall von Server-Neustarts (z.B. bei einer Wartung) werden die installierten Programme in die Autostart-Funktion des Servers eingebunden, sodass ein manuelles Starten aller Dienste (opsiconf, smb und ntpd) nicht erforderlich ist.

 

Ich wollte in den Anhang die technische Umsetzung als Befehlsliste (CMD-Befehle und Parameter) chronologisch dazu packen und in der Doku darauf verweisen (Verweise fehlen hier in der Passage noch).

Soll soetas mit in die Dokumentation oder nicht?

 

Lieben Gruß,

Havok2333

 

 

 

 

 

 

Bearbeitet 6. April 2016 von Havok2333

[Nitzan]

Moin,

Rein vom Gefühl her würde ich den Punkt "Abweichungen vom Projektantrag" eher im Fazit am Ende der Dokumentation behandeln. Hier kann man gut unterbringen, wenn etwas nicht geklappt hat oder länger gedauert hat, aber auch wenn etwas besser lief, als geplant.

[stefan.macke]

Das sehe ich anders. "Abweichungen vom Projektantrag" sind meiner Meinung nach Abweichungen, die sich zwischen Antrag und Umsetzung ergeben haben (z.B. der Kunde will jetzt doch einen anderen Server als ursprünglich gedacht) und dazu führen, dass das umgesetzte Projekt im Vergleich zum Antrag inhaltlich anders ablief. Diese Information würde ich direkt zu Beginn der Dokumentation platzieren.

Zusätzlich ist ein Soll-/Ist-Vergleich der Zeitplanung sinnvoll, der am Ende der Dokumentation durchgeführt wird. Hier sind ggfs. ein paar Stunden verschoben, aber die grundsätzlichen Projektinhalte sind gleich geblieben.