[Java] Dokumentation erstellen

Terrorbeat · 11. Januar 2013

Dokumentation erstellen

wie erstellt man eigentlich eine Dokumentation?

Ich habe in der Firma ein Programm erstellt das einmal im Jahr ausgeführt werden soll. Dieses Jahr geht es ohne Dokumentation, aber im nächsten Jahr bin ich vll nicht mehr da und andere Leute sollen das Programm weiter Programmieren können. Mir geht es hier nicht um JavaDoc sondern um eine allgemeinere Anleitung, ein typisches Manual halt über Hintergründe, Motivation, Beispiele, usw

Gibt es da richtlinien? Programme (kostenlos aber bitte)

Anzeige

swissmaster · 11. Januar 2013

AW: Dokumentation erstellen

Haha, klar gibt es ein Programm, welches dir die Motivation / Hintergründe generiert...

Nee scherz, Dokumentieren dauert bei sehr vielen Entwicklungsprojekten länger als das coden selber, ist nunmal so... Dokumentieren und Testing macht ein gutes Programm erst aus, nur coden kann jeder.

Das einzige was dir helfen kann sind Diagramme, welche du generieren kannst (UML), die helfen bei der visualisierung, was du gecodet hast (Objektabhängigkeiten und so).

Greez

Murdoc · 11. Januar 2013

AW: Dokumentation erstellen

Vielleicht ist es sinnvoll auch ein Lastenheft anzulegen, in dem du beschreibst was du gemacht hast bzw. was die Anforderungen waren usw.

Für Entwickler ist eine JavaDoc immer echt hilfreich, auch wenn du das schon weißt.
Gute Beschreibungen im Code sind nie verkehrt und die
dazugehörige HTML-Dokumentation gibts ja umsonst dazu

UML ist gut für die Beschreibung von Klassenhierarchien und Models/Datenbanken.

Ansonsten steht es dir frei WIE du das ganze Dokumentierst (irgendwelche Richtlinien sind mit nicht bekannt).

Du kannst dir ja ein wenig bei der Dokumentation des Android-SDK abschauen:

Package Index | Android Developers

Alex² · 11. Januar 2013

AW: Dokumentation erstellen

Wenn du deinen Code gut kommentiert hast, bist du schon fast fertig, wenn du die JavaDoc generieren lässt. Musst halt die Klassen und Methoden sauber kommentieren.

White_Angel · 11. Januar 2013

AW: Dokumentation erstellen

Kommentare sind immer wichtig, ich habe früher selber nie welche gemacht, aber habe es mir angewöhnt.
Wenn man mehrere Projekte aufeinmal hat, kann man sich nicht mehr an jeden Abschnitt jedes Projektes erinnern und das Debuggen bzw. Nachvollziehen kostet seine Zeit.

Allgemein würde ich sagen was in eine Dokumentation für Entwicker(Kein Handbuch) reingehört sind beschreibungen von:
- Klassen
- Methoden
- Strukturen/Aufbau (z.B. angelegte Dateien)

Dies würde ich aber nur tun, wenn das Programm sehr umfangreich ist, wenn es relativ klein ist reichen Kommentare völlig aus!

Terrorbeat · 12. Januar 2013

AW: Dokumentation erstellen

Ja danke erstmal.

Also wie gesagt es geht mir eigentlich gerade mehr um so ein Handbuch. Wenn in einem Jahr jemand anderes das Project übernimmt soll er anhand dieser Dokumentation erstmal erfahren worum es überhaupt geht, wie die Anforderung der Fachabteilung waren und wie es dann letztendlich realisiert wurde.

Aber da gibt es wohl keine genaueren Angabe zu wie man da vorgehen soll. Dann werde ich einfach ein Word-Dokument oder HTML Seite schreiben und dazu legen.

Kolazomai · 12. Januar 2013

AW: Dokumentation erstellen

Hallo!

Hier wuerde sich zum Gesamtueberblick ein Pflichtenheft (z.B. nach Balzert) anbieten. Da kannst du allgemeine und spezielle Informationen (Anforderungen) in geordneter Form angeben.

Zur Software selbst solltest du natuerlich deinen Code dokumentieren wie viele hier schon gesagt haben. Zur weiteren Verdeutlichung helfen UML-Diagramme (z.B. Use-Case-Diagramm, Aktivitaets-Diagramm, Klassen-Diagramm, Sequenz-Diagramm, ...).

Normalerweise sollte ein ordentliches System sowieso nie ohne verheriges Lastenheft/Pflichtenheft programmiert werden, das dann die Grundlage fuer das Verstaendnis der Anwendung liefert. Das ganze im Nachhinein zu erstellen ist also etwas ungewoehnlich

Mfg,

Kolazomai

Nützliche Suchen

[Java] Dokumentation erstellen

Videos zum Themenbereich