Fragen zu Abschlussprojekt Dokumentation

[phreeak]

Guten Tag,

ich bin neu hier und habe auch schon ein bisschen rumgeguckt, aber ich habe noch ein paar Fragen zu der Dokumentation meines Abschlussprojektes:

Ich mache ein internes Java Projekt (Java EE mit JSF).

- Wird für ein internes Projekt ein Pflichtenheft benötigt? Ich denke nicht, oder?

- Ich soll eine Entwicklerdokumentation erstellen. Ich habe eine Javadoc gemacht, allerdings ist diese nicht bzw. schwer in PDF-Form zu kriegen. Außerdem wäre diese viel zu lang. Reichen Auszüge aus der Entwicklerdoku oder muss diese vollständig sein? Eignet sich Javadoc als Doku dafür?

- UML Diagramme etc. kommen ja in Anhang, sollten diese selbst in der Dokumentation erwähnt bzw. beschrieben werden? Ich glaube ich beschreibe den Prozess dort ziemlich genau und würde es dann "beilegen" zu besseren Verständigung.

Ich hoffe ihr könnt mir da ein bisschen weiterhelfen.

Vielen Dank schonmal im Voraus!

phreeak

[MartinSt]

Wird für ein internes Projekt ein Pflichtenheft benötigt? Ich denke nicht, oder?

Wie willst du sonst die geplanten Features dokumentieren? Wogegen willst du sonst testen?

Ich habe eine Javadoc gemacht, allerdings ist diese nicht bzw. schwer in PDF-Form zu kriegen.

Warum? Bist du mit der Installation und Handhabung eines PDF-Druckers überfordert?

[phreeak]

Wie willst du sonst die geplanten Features dokumentieren? Wogegen willst du sonst testen?

Habe in meiner Dokumentation ja einen Punkt "Aufgabenstellung", aber kein typisches Pflichtenheft, weil es eben ein internes Projekt ist und mir mehr oder weniger schwammig gesagt wurde: "Mach das".

Warum? Bist du mit der Installation und Handhabung eines PDF-Druckers überfordert?

Doch bin ich in der Lage zu... Allerdings ist das wie gesagt viel zu lang, der Anhang sollte eine gewisse Länge nicht überschreiten.

[Klotzkopp]

Habe in meiner Dokumentation ja einen Punkt "Aufgabenstellung", aber kein typisches Pflichtenheft, weil es eben ein internes Projekt ist und mir mehr oder weniger schwammig gesagt wurde: "Mach das".

Es gibt keinen Grund, ein internes Projekt anders zu behandeln als eines mit einem externen Auftraggeber. Du nimmst dir durch das Weglassen von Projektteilen nur die Möglichkeit zu zeigen, was du kannst.

[MartinSt]

mir mehr oder weniger schwammig gesagt wurde: "Mach das".

Genau das ist der Knackpunkt.

Der Auftraggeber (egal ob intern oder extern) macht eine vage Problembeschreibung, es wird eine Lösung realisiert und der Auftraggeber sagt dann zur Übergabe: "Das habe ich mir ganz anders vorgestellt."

In externen Kundenprojekten führt das dann zu endlosen Diskussionen und Streitereien.

Deshalb: Pflichtenheft machen, Realisierung gegen das Pflichtenheft testen und übergeben - fertig.