Hallo zusammen.

Folgendes Problem. Ich habe gelesen, das es nicht so gut sein soll über 4 Ebenen zu verzweigen. Leider habe ich ein Projrekt mit verschiedenen Bereichen.

Beispiel:

3. Projektdokumentation

3.1. Übersicht

.

.

.

3.2.1. LoginMaske

3.2.2. KundenBereich

3.2.2.1. Nachrichten

3.2.2.2. persönliche Daten

3.2.2.3. Kontakt zu xxx

3.2.2.4. Projekt anschauen

3.2.3. AdminBereich

.

.

.

Ich möchte unter jedem Punkt die Funktionen erläutern ... soll ich das so Gliedern, oder kann ich die Bereiche auch als Überschrieften nehmen???

PS: Die Überschriften sind noch NICHT ausgereift!!!! Das muss ich noch überarbeiten!

DANKE

NiccYY

Du weisst aber, dass Du Dein Projekt und die Durchführung dokumentieren und nicht das Ergebnis in Art eiunes Benutzerhandbuches vorführen sollst?

Klingt von den Überschriften her ein wenig danach.

Ja das weis ich. Wie gesagt die Überschriften muss ich erst noch formulieren. Habe einfach noch nichts passendes gefunden.

Gob gesagt ist es so, das ich ein LoginBereich (HTML, PHP, MySQL) habe in dem gibt es einen Kunden und ein Admin Bereich. Hier kann man verschiedene Dinge ausführen. (Nachrichten lesen, senden - Kunden anlegen, löschen, ändern - Projekte anlegen, löschen, ändern - Projekte zuweisen usw.)

Diese möchte ich aber einzeln dokumentieren. Ich denke das es sonst zu unübersichtlich wird.

Ich möchte z.B. zu der Nachrichten-Versenden Routine ein PAP erstellen, den Login nur so dokumentieren usw. Aber ich denke ich muss ja zu jedem etwas sagen und kann nicht einfach Funktionen auslassen.

Nun ist es aber so das man im Kunden sowie im Admin Bereich Nachrichten versenden kann, jedesmal aber mit anderen optionen. So kann ich dies also nicht zusammenfügen!

Oder soll ich nur teile des ganzen dokumentieren?

Soll ich alle Funktionen nur unter einem Punkt erklären?

Naja, mir behagt eine zu stark untergliederte Dokumentation, bei der das Inhaltsverzeichnis dann schon über mehr als eine Seite geht, nicht so gut, was aber auch geschmackssache ist.

Persönlich würde ich z. B. die Funktionen im Kundenbereich unter einem Punkt erläutern usw. Dann besteht auch nicht die Gefahr, dass andere Teile der Dokumentation, wie die Durchführung ansich, eine Kostenanalyse o. ä. zu kurz kommen und das Ganze wie eine Beschreibung des fertigen Programms wirkt.

MM-Meine Meinung. ;-)

Ich werde vielleicht nochmal alles überdenken ist vielleicht Sinnvoll.

Danke auf alle Fälle!

Prinizipiell spricht nichts gegen eine tiefe Untergliederung. Das hängt aber stark vom Umfang des ganzen Dokuments ab, und bei dem Umfang unserer Projektdokus halte ich mehr als 2-3 Ebene für übertrieben. Das liefe dann darauf hinaus, dass auf der vierten Ebene kaum mehr als ein, zwei kleine Absätze stehen. Statt eines Gliederungspunktes kannst du einfach an den Anfang des Absatzes einen fett hervorgehobenen Einleitungssatz stellen. Beispiel:

3 Projektdokumentation

...

3.2.2 KundenBereich

...

Nachrichten: Hier kann sich der Kunde Nachrichten von anderen Benutzern anzeigen, löschen, beantworten und eigene Nachrichten an andere Benutzer verfassen.

Übrigens: Nach der letzten Zahl der Gliederungsnummer wird üblicherweise kein Punkt gesetzt, also "3.2.2" statt "3.2.2.".