Habe ein paar Probleme mit meiner Doku...

[BMAS]

Hallo Leute!

Ich habe ein paar Probleme mit meiner Projektdokumentation... hier mein Inhaltsverzeichnis:

1 Einleitung

1.1 Unternehmensbeschreibung

2 Projektbeschreibung

2.1 Ausgangslage

2.2 Projektauftrag

2.3 Änderungen gegenüber dem Projektantrag

3 Dokumentation

3.1 Grobkonzept

3.1.1 IST-Zustand

3.1.2 Soll-Konzept

3.2 Feinkonzept

3.2.1 Systementwurf

3.2.2 Programmentwurf

3.3 Pflichtenheft

4 Implementierung

4.1 Allgemein

4.1.1 Verwendete Software

4.1.2 Client-Server Kommunikation

4.2 Client

4.3 Server

4.4 Testphase

5 Auslieferung

5.1 Server

5.1.1 Systemvoraussetzungen

5.1.2 Installation

5.1.3 Konfiguration

5.2 Client

5.2.1 Systemvoraussetzungen

5.2.2 Installation

5.2.3 Konfiguration

5.3 Anwenderdokumentation

5.4 Übergabe

6 Projektergebniss

6.1 Soll-Ist-Vergleich

6.2 Evaluierung

7 Glossar

8 Index

9 Anhang

Ich finde das ganze ist ein wenig überladen oder? Das Inhaltsverzeichnis alleine nimmt schon über eine Seite in Anspruch und wenn ich jedes Kapitel ausführe und da noch Bilder reinkommen... tja, vielleicht könnt ihr mir ja helfen, was kann raus und was fehlt noch?

Mit 4.1.2 bin ich noch nicht ganz zufrieden, das passt dort nicht hin, sollte das nicht lieber ein eigener Punkt sein?

Gehört 4.4 in die Implementierung oder in die Auslieferung? War mir da nicht so ganz sicher, nachdem ich mir einige Beispiele angeschaut habe.

Oh, und ausserdem, soll das Pflichtenheft in den Anhang oder lieber in die Doku? Wenn in den Anhang, dann würde ich unter 3.3 nur schreiben "siehe Anhang xyz". Wäre das okay?

Ich hoffe ihr antwortet mir, vielen Dank im Vorraus!

Grüsse BMAS

[Bako]

Hi,

Original geschrieben von BMAS

Ich finde das ganze ist ein wenig überladen oder? Das Inhaltsverzeichnis alleine nimmt schon über eine Seite in Anspruch und wenn ich jedes Kapitel ausführe und da noch Bilder reinkommen... tja, vielleicht könnt ihr mir ja helfen, was kann raus und was fehlt noch?

Ich finde das Ganze eigentlich sehr ausgereift und es fehlt mir auf den ersten Blick erstmal nicht. Ich würds so lassen.

Mit 4.1.2 bin ich noch nicht ganz zufrieden, das passt dort nicht hin, sollte das nicht lieber ein eigener Punkt sein?

Das kann man so nicht sagen, dazu wäre es hilfreich, wenn Du posten würdest, was genau Dein Projekt ist.

Gehört 4.4 in die Implementierung oder in die Auslieferung? War mir da nicht so ganz sicher, nachdem ich mir einige Beispiele angeschaut habe.

Gehört in die Implementierung. Du solltest auf jeden Fall testen, bevor Du das Projekt auslieferst.

Oh, und ausserdem, soll das Pflichtenheft in den Anhang oder lieber in die Doku? Wenn in den Anhang, dann würde ich unter 3.3 nur schreiben "siehe Anhang xyz". Wäre das okay?

Wenn Du es als Extra-Punkt aufführst, sollte es dann auch dahin. Du könntest aber auch den Punkt rausnehmen, und im Punkt 3.1.2 (Soll-Konzept) die wichtigsten Punkte nennen, für Details auf das Anhang befindliche Pflichtenheft verweisen.

[BMAS]

Original geschrieben von Bako

Ich finde das Ganze eigentlich sehr ausgereift und es fehlt mir auf den ersten Blick erstmal nicht. Ich würds so lassen.]

Oh vielen dank, ist schön zu hören! Da hat es sich ja gelohnt, sich mal auf den Hintern zu setzen und sich ein paar Gedanken zu machen!

Das kann man so nicht sagen, dazu wäre es hilfreich, wenn Du posten würdest, was genau Dein Projekt ist.

Mein Programm soll eine Verwaltung für unsere Lieferanten und Dienstleister werden. Der Server hat die Aufgabe, den DB Zugriff zu synchronisieren und den Clients Methoden zur Verfügung zu stellen, um diesen den Zugriff auf die DB zu ermöglichen (ist eine Anforderung an meine Anwendung, Client, Server und DB sollen austauschbar sein).

Oh und übrigens die DB ist nicht Bestandteil meines Projekts...

Gehört in die Implementierung. Du solltest auf jeden Fall testen, bevor Du das Projekt auslieferst.

Okay, ist einleuchtend.

Wenn Du es als Extra-Punkt aufführst, sollte es dann auch dahin. Du könntest aber auch den Punkt rausnehmen, und im Punkt 3.1.2 (Soll-Konzept) die wichtigsten Punkte nennen, für Details auf das Anhang befindliche Pflichtenheft verweisen.

Was wäre denn deiner Meinung nach besser? Normalerweise tue ich das Pflichtenheft in den Anhang, nur habe ich bisher erst 2 bis 3 Dokus geschrieben und habe von daher noch nicht sooooo viel Erfahrung...

Und vielen Dank, dass du mir geantwortet hast! Hätte nicht gedacht, dass ich überhaupt eine Antwort vor Montag bekomme.

[timmi-bonn]

Original geschrieben von BMAS

Ich habe ein paar Probleme mit meiner Projektdokumentation... hier mein Inhaltsverzeichnis:

[...]

Ich habe Probleme, anhand des Inhaltsverzeichnisses die Eigenleistung zu erkennen.

Nicht falsch verstehen! Die Gliederung sieht so OK aus. Aber ich kann sie aufgrund fehlender Informationen nicht so recht inhaltlich bewerten. Daher weiß ich nicht, ob nix Fachliches fehlt. Dieses Inhaltsverzeichnis könnte auch in einem Projekt Verwendung finden, in dem ausschlißlich vorgefertigte Komponenten "zusammengestöpslt" werden.

Kurz: Das Inhaltsverzeichnis selbst ist OK; aber das sagt nix darüber aus, ob es dem Projekt angemessen ist. - Oder gar, ob das Projekt ausreichende Tiefe hat.

gruß, timmi

[Bako]

Original geschrieben von BMAS

Mein Programm soll eine Verwaltung für unsere Lieferanten und Dienstleister werden. Der Server hat die Aufgabe, den DB Zugriff zu synchronisieren und den Clients Methoden zur Verfügung zu stellen, um diesen den Zugriff auf die DB zu ermöglichen (ist eine Anforderung an meine Anwendung, Client, Server und DB sollen austauschbar sein).

Oh und übrigens die DB ist nicht Bestandteil meines Projekts...

Hmm... dann würde ich den Punkt hinter 4.2 und 4.3 setzen, nachdem Du Client und Server beschrieben hast.

Was wäre denn deiner Meinung nach besser? Normalerweise tue ich das Pflichtenheft in den Anhang, nur habe ich bisher erst 2 bis 3 Dokus geschrieben und habe von daher noch nicht sooooo viel Erfahrung...

Ich hab bisher auch nur eine Doku geschrieben, die für meine Prüfung...

Ich würde im Soll-Konzept das Grobe umreißen, für Details auf den Anhang verweisen und das Pflichtenheft in den Anhang tun und keinen eigenen Punkt Pflichtenheft außerhalb des Anhangs machen. Schon allein wenn ihr eine Seitenbegrenzung habt, gibt Dir das Einiges an Freiraum, da der Anhang ja nicht seitentechnisch mitgezählt wird üblicherweise.

Und vielen Dank, dass du mir geantwortet hast! Hätte nicht gedacht, dass ich überhaupt eine Antwort vor Montag bekomme.

[BMAS]

Hmm... dann würde ich den Punkt hinter 4.2 und 4.3 setzen, nachdem Du Client und Server beschrieben hast.

Okay, mache ich...

Ich hab bisher auch nur eine Doku geschrieben, die für meine Prüfung...

Ich würde im Soll-Konzept das Grobe umreißen, für Details auf den Anhang verweisen und das Pflichtenheft in den Anhang tun und keinen eigenen Punkt Pflichtenheft außerhalb des Anhangs machen. Schon allein wenn ihr eine Seitenbegrenzung habt, gibt Dir das Einiges an Freiraum, da der Anhang ja nicht seitentechnisch mitgezählt wird üblicherweise.

Also hat es die gesamte Spezies Fachinformatiker nicht so mit dem dokumentieren was?

Neija, eine Seitenbegrenzung haben wir nicht, aber wenn das ganze zu lang wird, geht es den Prüfern doch auf den Geist, denke ich mal. Also kommt mein Pflichtenheft in den Anhang.

[BMAS]

Nicht falsch verstehen!

Würde ich nie, ich bin für jede Hilfe dankbar!

Die Gliederung sieht so OK aus. Aber ich kann sie aufgrund fehlender Informationen nicht so recht inhaltlich bewerten. Daher weiß ich nicht, ob nix Fachliches fehlt. Dieses Inhaltsverzeichnis könnte auch in einem Projekt Verwendung finden, in dem ausschlißlich vorgefertigte Komponenten "zusammengestöpslt" werden.

Hmm, also das habe ich in meinem letzten Post geschrieben:

Mein Programm soll eine Verwaltung für unsere Lieferanten und Dienstleister werden. Der Server hat die Aufgabe, den DB Zugriff zu synchronisieren und den Clients Methoden zur Verfügung zu stellen, um diesen den Zugriff auf die DB zu ermöglichen (ist eine Anforderung an meine Anwendung, Client, Server und DB sollen austauschbar sein).

Oh und übrigens die DB ist nicht Bestandteil meines Projekts...

Okay, ist vielleicht nicht ausführlich genug, hier noch mal ein paar weitere Punkte:

Unsere Lieferanten und Dienstleister wurden überhaupt nicht verwaltet, sprich, niemand wusste so genau wo er bestellen darf und kann.

Aus diesem Grund hat sollte ich eine Anwendung (wie gesagt nur die Anwendung, die DB wird von einem Kollegen erstellt) erstellen, die es ermöglicht die Lieferanten zu verwalten (anlegen, editieren, löschen).

Jedem Mitarbeiter soll es möglich sein, Lieferanten nach bestimmten Kriterien zu suchen und sich die Treffer anzeigen zu lassen.

Ausserdem soll jeder Mitarbeiter eine allgemeine Bewertung zu einem Lieferanten abgeben können (einfach nur eine Benotung + eine Begründung).

Diese Bewertungen sollen auch verwaltet werden können(nur löschen, editieren ist nicht notwendig)

Die Software soll eine, komplett in Java geschriebene, Client-Server Anwendung werden.

Der Server sorgt dafür, dass die Datenbankabfragen synchronisiert werden und stellt den Clients Methoden zur Verfügung, die den Zugriff auf die Datenbank ermöglichen. Dadurch sollen inkonsistente Datensätze vermieden werden.

Der Client soll eine benutzerfreundliche Java Swing Oberfläche bieten, die sich nach den Apple Human Guidelines richtet.

Aufgrund der Menge der Clients (so um die 800), soll die Software den Benutzern, über unseren Citrix Metaframe Terminal Server als veröffentlichte Anwendung zur Verfügung stehen (die Zeit die ich für die Auslieferung gebraucht habe wurde dadurch auf nicht mal 1 Stunde reduziert...).

Ich hoffe mal das sind genug Infos, die Software ist fertig, ich brauche nur noch die Doku schreiben und das Ganze abzuschicken...

Oh und bitte wenn ihr Reschtschreibfehler findet, dann seit gnädig mit mir, ich habe gerade unter grässlichen Kopfschmerzen zu leiden. (Und das bei dem Wetter! Toll!)

Grüsse BMAS

[BMAS]

4.1.1 Verwendete Software

Ist das dort richtig? Sollte es nicht lieber ein eigener Punkt zwischen Projektergebniss und Glossar sein?

[Bako]

Original geschrieben von BMAS

4.1.1 Verwendete Software

Ist das dort richtig? Sollte es nicht lieber ein eigener Punkt zwischen Projektergebniss und Glossar sein?

Ich finde schon, dass es dort richtig ist, denn darüber machst Du Dir ja in der Planungs- und Implementierungsphase schon Gedanken, welche Software Du für Dein Projekt einsetzen möchtest.

[BMAS]

Original geschrieben von Bako

Ich finde schon, dass es dort richtig ist, denn darüber machst Du Dir ja in der Planungs- und Implementierungsphase schon Gedanken, welche Software Du für Dein Projekt einsetzen möchtest.

Klingt einleuchtend, danke! Ich werde mal alles überarbeiten und das ganze morgen nochmal posten...

Grüsse BMAS

[BMAS]

Wo sollte ich denn eurer Meinung nach die USE-CASES reintun?

Untrer 3.1.2 Soll Konzept würde ich vorschlagen...

[Bako]

Original geschrieben von BMAS

Wo sollte ich denn eurer Meinung nach die USE-CASES reintun?

Untrer 3.1.2 Soll Konzept würde ich vorschlagen...

Ich weiß leider nicht, was USE-CASES sind, insofern kann ichs Dir nicht genau beantworten...

Klingt für mich aber eher nach konkreten Umsetzungsmöglichkeiten innerhalb Deines Programmes an. Im Soll-Konzept beschreibt man ja eher allgemein, wie Du die Problemstellung lösen willst, in der Implementierung beschreibst Du dann, mit was genau Du Dein Soll-Konzept in die Tat umsetzt.

[BMAS]

Warte mal... *googlegoogle*

USE CASE Diagramm = Anwendungsfalldiagramm

Ich will damit zeigen welche Aktionen dem Benutzer zur Verfügung stehen und welche nur dem Admin vorbehalten sind.

[Bako]

Original geschrieben von BMAS

Warte mal... *googlegoogle*

USE CASE Diagramm = Anwendungsfalldiagramm

Ich will damit zeigen welche Aktionen dem Benutzer zur Verfügung stehen und welche nur dem Admin vorbehalten sind.

Ah, OK, Danke für die Info, ich hab mit sowas nahezu nie zu tun, deswegen war mir das nicht bekannt...

Wenn ich das dann richtig verstehe, gehört das zum Soll-Konzept.

[BMAS]

Und wo sollte ich die Aufstellung reintun, wieviel Zeit ich für was gebraucht habe?

[Bako]

Original geschrieben von BMAS

Und wo sollte ich die Aufstellung reintun, wieviel Zeit ich für was gebraucht habe?

Wenn Du's überhaupt reinbringst (ich habs damals nicht gemacht), würde ichs bei Dir unter Punkt 6 (Projektergebnis) irgendwo.

Wo ich mir da nochmal die Gliederung anschaue, machst Du eigentlich auch ne Kosten-Nutzen-Gegenüberstellung (Wirtschaftlichkeitsanalyse) oder ist das unter "Evaluierung" zu finden? Das würde sonst nämlich noch fehlen...

[BMAS]

Hmm, unter Evaluierung wollte ich zusammenschreiben, wie sich die Situation verbessert hat.

Eine Kosten- Nutzen Gegenüberstellung hatte ich nicht geplant, was ist das genau und wie macht man das?

[Bako]

Naja, Du solltest die Kosten Deines Projektes dem Nutzen Deines Projektes gegenüber stellen.

Unter Kosten zählen zum Beispiel Lizenzkosten für z.B. Betriebssysteme, Software, Hardwarekosten, Arbeitszeit, Wartungskosten, etc...

Denn den Projektauftraggeber interessiert natürlich auch, wieviel Geld er für Dein Projekt ausgeben muss. Im Prinzip reicht da eine Aufstellung, da man die Kosten größtenteils halbwegs genau beziffern kann bzw. hochrechnen kann.

Dem gegenüber stellst Du den Nutzen (Zeitersparnis beim Arbeiten damit etc.). Dabei sollte klarwerden, dass der Nutzen Deines Projektes die Kosten überwiegt.

Das Ganze dann am Besten in einem eigenen Kapitel das so heisst wie "Wirtschaftlichkeitsanalyse".

Das sollte man übrigens auch machen, wenn es "nur" ein internes Projekt ist! Kostenbewußtsein ist auch ein wichtiger Teil eines Projektes.

[hades]

Original geschrieben von BMAS

1 Einleitung

1.1 Unternehmensbeschreibung

2 Projektbeschreibung

[...]

Der Punkt 1.1 kommt mir etwas einsam vor.

Entweder in Punkt 1 mit einfliessen lassen oder einen Punkt 1.2 einfuegen.

Ansonsten sieht es gut aus.

[BMAS]

@Bako

Vielen Dank! (ich glaube ich wiederhole mich )

Dann werde ich am Dienstag mal meine Wirtschaflichkeitsanalyse machen...

Hmm, mein Projekt ist jedoch ein Teilprojekt, die Datenbank macht ein anderer Azubi als Abschlussprojekt, soll ich die Kosten der DB dann auch in meine Analyse einfliessen lassen? Oder reicht es, wenn ich die Kosten aufzähle, die nur durch mein Teilprojekt entstanden sind.

Wenn ich die Kosten in tabellarischer Form aufzähle und da drunter den Nutzen meines Projekts ausformuliere, reicht das dann schon?

@Hades

Stimmt! Da kommt noch unter 1.2 die Erklärung rein, in der ich verichere, dass ich mein Projekt alleine gemacht habe! Hätte ich fast vergessen! Danke!

[Bako]

Original geschrieben von BMAS

@Bako

Vielen Dank! (ich glaube ich wiederhole mich )

Kein Problem. Hier werden Sie geholfen.

Dann werde ich am Dienstag mal meine Wirtschaflichkeitsanalyse machen...

Hmm, mein Projekt ist jedoch ein Teilprojekt, die Datenbank macht ein anderer Azubi als Abschlussprojekt, soll ich die Kosten der DB dann auch in meine Analyse einfliessen lassen? Oder reicht es, wenn ich die Kosten aufzähle, die nur durch mein Teilprojekt entstanden sind.

Es müssten die Kosten Deines Teilprojektes reichen. Dann solltest Du allerdings kurz erwähnen, dass, um Dein Projekt zu realisieren, gewisse Voraussetzungen geschaffen sein müssen.

Wenn ich die Kosten in tabellarischer Form aufzähle und da drunter den Nutzen meines Projekts ausformuliere, reicht das dann schon?

Ich denke schon, so hab ichs damals auch gemacht.

[BMAS]

Ich danke dir! Wenn du mal in München bist, dann sag´ bescheid, ich lade dich dann zum Dank auf einen Kaffe ein!

[hades]

Original geschrieben von BMAS

Stimmt! Da kommt noch unter 1.2 die Erklärung rein, in der ich verichere, dass ich mein Projekt alleine gemacht habe! Hätte ich fast vergessen! Danke!

Das passt aber nicht zu einer Einleitung.

Die persoenliche Erklaerung wird normalerweise als letzte Seite des Hauptteils (manchmal auch als letzte Seite im Anhang) eingefuegt.

Meist gibt es Vorgaben, wie diese Erklaerung aussehen soll. Wenn keine Vorgabe existiert, dann kannst Du die aus dem Handbuch zur Abschlusspruefung IT-Berufe (hier wird das Buch vorgestellt) uebernehmen.

Wenn die persoenliche Erklaerung an dieser Stelle eine Vorgabe Deiner IHK ist, dann mache es so wie Deine IHK es gerne haben moechte.

[Bako]

Original geschrieben von BMAS

Ich danke dir! Wenn du mal in München bist, dann sag´ bescheid, ich lade dich dann zum Dank auf einen Kaffe ein!

Da komme ich drauf zurück, wenn ich mal in München sein sollte (München ist leider nur so weit weg... ).

Ansonsten, wenn noch weitere Fragen sind, immer her damit.

[BMAS]

Original geschrieben von hades

Das passt aber nicht zu einer Einleitung.

Die persoenliche Erklaerung wird normalerweise als letzte Seite des Hauptteils (manchmal auch als letzte Seite im Anhang) eingefuegt.

Meist gibt es Vorgaben, wie diese Erklaerung aussehen soll. Wenn keine Vorgabe existiert, dann kannst Du die aus dem Handbuch zur Abschlusspruefung IT-Berufe (hier wird das Buch vorgestellt) uebernehmen.

Wenn die persoenliche Erklaerung an dieser Stelle eine Vorgabe Deiner IHK ist, dann mache es so wie Deine IHK es gerne haben moechte.

Oha! Da hätte ich wohl fast einen Fehler gemacht... ich glaube ich rufe lieber mal in der IHK an und frage nach, wie die es gerne hätten. Danke!

@Bako

Wie gesagt, das Angebot steht.

Und mir werden sicher noch ein paar Fragen einfallen, mit denen ich dich nerven kann.