Projektdoku - Gliederung

[iKilledKenny]

hi leutz,

bin gerade dabei meine doku zu schreiben und würde gerne mal wissen, wie detailliert andere ihre gliederung der doku angelegt haben.

bin dankbar für jede anregung.

grüße aus hamburg

alex

[DPruess]

Hi iKilledKenny,

wie meinst Du das ??? Meinst Du eine simple Gliederung als Inhaltsangabe in Deiner Projektdoku oder wie ??? ...

Also, sicherlich hast Du da ein paar Überschriften, die in Deiner Doku vorkommen. Benutze die doch erstmal, um zu schauen, wie der Gesamteindruck ist.....

Sicherlich solltest Du am Ende Deiner Doku nicht fiese Verzweigungen ala..

1.

1.1

1.1.1

1.1.1.1.1.1.1.1.1.1.1.1.1.1.1 usw.

haben. Wie detailiert Du das haben willst, ist eigentlich jedem selbst überlassen.

Ich würde Dir empfehlen:

3-4 Unter-"Überschriften", mehr nicht...

Grüße aus Lübeck !!

[Chipsy]

Hi,

ich sitze auch gerade an der Doku (

Ich nehme als Inhaltsverzeichnis die Überschriften meiner Dokumentationen (Plichtenheft, Lastenheft, Testkonzept, Projektdokumentation) + die Anlagen.. z.B. bei der Pro-doku.

1. Anlagen

1.2. Lastenheft

1.3. Plichtenheft

1.4. ....

und unter diesen Punkten beschreibe ich, was die einzelnen Dokumente machen, wafür sie sind usw.

Ich habe max. bis zu 5 Untergliederungspunkte

hier mal das Inhaltsverzeichnis meines Lastenheftes... vielleicht hilft es dir weiter:

1 GLOSSAR 3

2 AUFTRAGGEBER/ KUNDE 3

3 AUFTRAGNEHMER 3

4 AUSGANGSSITUATION 3

5 ZIELSETZUNG 4

5.1 MUßKRITERIEN 4

5.1.1 Tool 4

5.1.2 HTML-Seiten 4

5.2 KANNKRITERIEN 4

5.2.1 Tool 4

5.2.2 HTML-Seiten 5

6 BETROFFENE BEREICHE 5

7 TERMINE 5

8 QUALITÄTSANFORDERUNGEN 5

9 GROBBESCHREIBUNG VOM AUFTRAGGEBER 6

9.1 RANDBEDINGUNGEN 6

9.2 TEILAUFGABEN 6

9.3 VORGEHENSWEISE 6

viel Glück

chipsy

chipsy

[Webentwickler]

Ahoi,

hat Dir die IHK keine Anleitung mitgeschickt? Normalerweise macht die IHK HH es.

Jier ist ein Teil, was die mir damals geschickt haben.

Für das Inhaltsverzeichnis / Gliederung haben sich die alphanumerische Ordnung (Buchstaben-Ziffern-System, sie Beispiel 1) und die Dezimalordnung (siehe Beispiel 2) bewährt.

Beispiel 1:

A. ........... Seite 2

I. ..................4

1. ..................5

2. ..................8

a)..................9

a.a)...............11

Beispiel 2:

1. .................Seite 2

1.1 .....................4

1.1.1. .................6

1.1.2. .................7

1.2. ....................9

2. ......................10

Webentwickler

[Dragon-Master]

Hi,

ein Inhaltsverzeichnis kann auch ohne Nummerierung auskommen, solange es übersichtlich bleibt.

Ich habe mein Inhaltsverzeichnis so aufgebaut:

Inhaltsverzeichnis

Inhaltsverzeichnis 1

Vorwort 2

Programmiervorgaben 3

Datenbankaufbau 5

Dialogprogramm AR342D 8

Dialogprogramm AR343D 13

Batchprogramm AR632B 16

Unterprogramm AR103N1 19

Zeitaufstellung 20

Abbildungsverzeichnis 21

Anhang A : Quellcode AR342D A - 1

Anhang B : Quellcode AR343D B - 1

Anhang C : Quellcode AR634B C - 1

Anhang D : Quellcode AR103N1 D - 1

Anhang E : JCL JPVAZALL E - 1

Wenn man lieber eine Gliederung als ein Inhaltsverzeichnis anlegen will, so sollte man jedoch eine Nummerierung und Unterpunkte mit aufnehmen. Unterpunkte aber maximal bis zu 3.Ebene. Entscheidend ist aber immer der optische Gesamteindruck. Wenn eine Seite Vollgepfopft ist und man vor lauter fett und unterstreichen nichts mehr erkennen kann, dient beides nicht mehr der Orientierung in der Doku. Also Übersichtlichkeit ist alles

Dragi

[kreisler]

<BLOCKQUOTE><font size="1" face="Verdana, Arial, Helvetica">Zitat:</font><HR>Original erstellt von Dragon-Master:

Entscheidend ist aber immer der optische Gesamteindruck. Wenn eine Seite Vollgepfopft ist und man vor lauter fett und unterstreichen nichts mehr erkennen kann, dient beides nicht mehr der Orientierung in der Doku. Also Übersichtlichkeit ist alles

Dragi

[iKilledKenny]

hi @dragon-master,

deinen ausführungen entnehme ich, dass du deinen quellcode in die doku mit eingebunden hast.

ich bin mir nicht sicher, ob das verlangt ist. es existieren ja noch andere beiträge in diesem forum, wo darauf bezug genommen wird und ganz unterschiedliche kommentare zu lesen sind.

an alle anderen:

BITTE EIN KURZES STATEMENT, OB IHR DEN QUELLCODE AUFGENOMMEN HABT ODER NICHT.

DANKE.

grüße an die republik

[Mirko]

Ich habe den Quellcode nicht mit in die Doku genommen, habe ihn aber mit auf die CD gepackt, die ich neben meiner Doku eingereicht habe. In der Doku habe ich im Anhang nur kurz den Inhalt der CD beschrieben.

[Dragon-Master]

Bei mir steht der Quellcode nicht in der Doku sondern ist im Anhang. In der Doku selbst habe ich nur die Funktionen der Programme erklärt.

Ob man den Quellcode mit an die IHK liefert oder nicht ist wirklich Geschmackssache. Ich hab meinen BS-Lehrer in Prüfungsausschuß gefragt, ob er den Quellcode mit haben will. Seine Antwort war: "Der gehört doch auch zum Projekt".

Also gut pack ich ihn halt in den Anhang rein. (den Quellcode nicht den Lehrer )

Dragi

[Dragon-Master]

<BLOCKQUOTE><font size="1" face="Verdana, Arial, Helvetica">Zitat:</font><HR>Original erstellt von kreisler:

Und Rechtschreibung auch...

[iKilledKenny]

kinderkacke @dragon und @kreisler!

wenn ihr sonst nix zu tun habt, muss uns um die zukunft unseres vereinigten europa ja nich bange sein.

in diesem sinne: weiter so!!!

[kreisler]

@iKilledKenny

Seriositaet ist mein taegliches Geschaeft, und dahin kehren wir jetzt auch wieder zurueck.

Danke fuer die Ermahnung, nix fuer Ungut

@dragi

Ach, das kommt von deinem (wie du sicher zugibst) arroganten und substanzlosen Gewaesch aus dem neuesten Thread zum Thema "Geld" http://www.fachinformatiker-berufe.de/ubb/Forum1/HTML/000432.html.

Ist aber auch jetzt rum, denn das Thema ist ja tot...

;-)

[Dieser Beitrag wurde von kreisler am 07. Dezember 2000 editiert.]

[Dieser Beitrag wurde von kreisler am 07. Dezember 2000 editiert.]

[Dragon-Master]

<BLOCKQUOTE><font size="1" face="Verdana, Arial, Helvetica">Zitat:</font><HR>Original erstellt von kreisler:

@iKilledKenny

Seriositaet ist mein taegliches Geschaeft, und dahin kehren wir jetzt auch wieder zurueck.

Danke fuer die Ermahnung, nix fuer Ungut

@dragi

Ach, das kommt von deinem (wie du sicher zugibst) arroganten und substanzlosen Gewaesch aus dem neuesten Thread zum Thema "Geld" (http://www.fachinformatiker-berufe.de/ubb/Forum1/HTML/000432.html).

Ist aber auch jetzt rum, denn das Thema ist ja tot...

;-)

[gajUli]

Hi all,

noch ein Wort zu den geposteten Inhaltsverzeichnissen. Dieses beginnt ueberlicherweise NICHT auf Seite eins.

(Seite eins ist immer dort, wo nach dem Inhaltsverzeichnis die eigentliche Arbeit beginnt, also Kap. 1. )

Uli

[Webentwickler]

<BLOCKQUOTE><font size="1" face="Verdana, Arial, Helvetica">Zitat:</font><HR>Original erstellt von iKilledKenny:

BITTE EIN KURZES STATEMENT, OB IHR DEN QUELLCODE AUFGENOMMEN HABT ODER NICHT.

DANKE.

grüße an die republik

[iKilledKenny]

danke an alle, die mir hier mit ihren beiträgen gehlfen haben.

doku wurde gestern abgegeben und heute habe ich leichte kopfschmerzen ob der feierei gestern.

allen, die noch dran sind: gutes gelingen !

Alex