Habe ein paar Probleme mit meiner Doku...

[BMAS]

Hi!

Hier nochmal mein neues Inhaltsverzeichnis:

1 Einleitung

1.1 Unternehmensbeschreibung

1.2 Ausgangslage und Projektauftrag

2 Konzeptionierung

2.1 Grobkonzept

2.1.1 Ist-Zustand

2.1.2 Soll-Konzept

2.2 Feinkonzept

2.2.1 Systementwurf

2.2.2 Programmentwurf

3 Entwicklung

3.1 Allgemein

3.1.1 Verwendete Software

3.1.2 Verwendete Hardware

3.2 Entwicklung des Clients

3.2.1 Gestaltung der Oberfläche

3.2.2 Anbindung an den Server

3.3 Entwicklung des Servers

3.4 Client-Server Kommunikation

3.5 Testphase

4 Auslieferung

4.1 Auslieferung des Servers

4.1.1 Systemvoraussetzungen

4.1.2 Installation

4.2 Auslieferung des Clients

4.2.1 Systemvoraussetzungen

4.2.2 Installation

4.3 Anwenderdokumentation

4.4 Übergabe

5 Projektergebnis

5.1 Soll-Ist-Vergleich

5.2 Wirtschaftlichkeitsanalyse

6 Glossar

7 Index

8 Quellenverzeichnis

9 Anhang

Ich habe da wirklich eine Menge geändert, z.B. steht die Einleitung nicht mehr alleine da. Ausserdem habe ich die Wirtschaflichkeitsanalyse hinzugenommen, den Punkt 3.2 weiter untergliedert, sowie Die Ausgangslage und den Projektauftrag zu einem Punkt zusammen gefasst.

Oh und ausserdem habe ich jetzt auch einen Index und ein Quellenverzeichnis!

Aber ein paar Fragen habe ich noch:

1. Punkt 5.1 Soll-Ist Vergleich: Reicht da einfach ein kurzer Text, der beschreibt, welche Ziele erreicht wurden und welche nicht, oder verstehe ich den Punkt falsch?

2. Punkt 1.1 Unternehmensbeschreibung: Öhm tja, ich soll da wohl mein Unternehmen beschreiben oder? Müssen da auch aktuelle Zahlen rein? Die darf ich wahrscheinlich gar nicht nennen (wurde mir heute gesagt)! Und wie genau muss die Beschreibung sein? Reicht es, wenn ich schreibe was mein Unternehmen macht oder muss da auch noch die Geschichte rein?

Ich würde am liebsten kurz mein Unternehmen beschreiben, dann was es macht und dann einfach auf unsere Homepage verweisen, falls noch Interesse an weiteren Infos besteht.

3. Was muss denn unbedingt in die Testphase rein? Bisher habe ich eigentlich nur eine Aufstellung, welche Tests durchgeführt worden sind...

4. Den Punkt 4.3, Anwenderdokumentation ist doch eigentlich unwichtig oder? Reicht es, wenn ich den Benutzerleitfaden in den Anhang tue und in der Doku selber nichts darüber schreibe?

5. Punkt: 3.2.1 Gestaltung der Oberflächen: Eine Idee was ich dazu schreiben kann? Ich habe ursprünglich vor gehabt, da Screenshots aller GUIs zu zeigen (7 Stück) und wollte dann näher auf diese eingehen... Ich finde es schon wichtig, demjenigen der die Doku liest auch mal das Programm selber zu zeigen, damit er sich was drunter vorstellen kann. Aber irgendwie würde dieser Punkt doch sehr dem Benutzerleitfaden ähneln.

Was würdet ihr in diesen Punkt reinschreiben?

[Bako]

Original geschrieben von BMAS

1. Punkt 5.1 Soll-Ist Vergleich: Reicht da einfach ein kurzer Text, der beschreibt, welche Ziele erreicht wurden und welche nicht, oder verstehe ich den Punkt falsch?

Im Prinzip ja. Nimm quasi Dein Pflichtenheft, prüfe, ob die vereinbarten Punkte eingehalten wurden und formulier Dein Ergebnis kurz schriftlich.

2. Punkt 1.1 Unternehmensbeschreibung: Öhm tja, ich soll da wohl mein Unternehmen beschreiben oder? Müssen da auch aktuelle Zahlen rein? Die darf ich wahrscheinlich gar nicht nennen (wurde mir heute gesagt)! Und wie genau muss die Beschreibung sein? Reicht es, wenn ich schreibe was mein Unternehmen macht oder muss da auch noch die Geschichte rein?

Ich würde am liebsten kurz mein Unternehmen beschreiben, dann was es macht und dann einfach auf unsere Homepage verweisen, falls noch Interesse an weiteren Infos besteht.

Ich habe damals kurz reingeschrieben, in welcher Branche mein Unternehmen tätig ist und dann einen Bogen zum Projekt gespannt, indem ich auch ganz grob auf die IT-Infrastruktur eingegangen bin. ("Das Projekt wird im Hause der Firma ABC durchgeführt, die ein Tochterunternehmen der XYZ ist und in der Lebensmittelbranche tätig ist. Die Firma ABC ist über ... vernetzt, etc..."). Sehr viel detaillierter braucht das denke ich nicht zu sein, Verkaufszahlen oder Aktienkursentwicklung der letzten 5 Jahre sind nicht notwendig, nur alles was für das Projekt wissenswert ist.

3. Was muss denn unbedingt in die Testphase rein? Bisher habe ich eigentlich nur eine Aufstellung, welche Tests durchgeführt worden sind...

Das wäre ein Punkt. Zudem dazu auch noch, warum dieser Test notwendig ist, und die Testergebnisse. Im Anhang kannst Du dann z.B. noch Testprotokoll in Form z.B. einer abgehakten Checkliste einbringen.

4. Den Punkt 4.3, Anwenderdokumentation ist doch eigentlich unwichtig oder? Reicht es, wenn ich den Benutzerleitfaden in den Anhang tue und in der Doku selber nichts darüber schreibe?

Denke ich auch. Schreib kurz, dass eine erstellt worden ist, um dem Anwender die Arbeit mit dem Produkt zu erleichtern, weil es im Pflichtenheft so gefordert wurde, ... und verweise auf den Anhang, die Anwenderdoku brauchst Du dann nicht nochmal reinsetzen.

5. Punkt: 3.2.1 Gestaltung der Oberflächen: Eine Idee was ich dazu schreiben kann? Ich habe ursprünglich vor gehabt, da Screenshots aller GUIs zu zeigen (7 Stück) und wollte dann näher auf diese eingehen... Ich finde es schon wichtig, demjenigen der die Doku liest auch mal das Programm selber zu zeigen, damit er sich was drunter vorstellen kann. Aber irgendwie würde dieser Punkt doch sehr dem Benutzerleitfaden ähneln.

Was würdet ihr in diesen Punkt reinschreiben?

Hhmm... evtl. schreib rein, wie Du die GUIs erstellt hast, mit welcher Software, nach welchen Gesichtspunkten (Ergonomie, Übersichtlichkeit, Bedienungskomfort, etc...) Du die GUIs erstellt hast. Das fällt mir spontan dazu ein.