Zum Forum springen
Benachrichtigungen
Alles löschen

Dokumentation für Softwareprojekt

4 Beiträge
3 Benutzer
1 Reactions
653 Ansichten
grimbadul
Beigetreten: 20.08.2009
PokerStrategist

Hallo zusammen,

ich muss für ein abgeschlossenes Softwareprojekt eine Gebrauchsdokumentation erstellen. Sprich, für Leute, die mit dem Code weiterarbeiten wollen (nicht für die Anwender der Software). Ich habe sowas noch nie gemacht. Wie gehe ich das Ganze an? Aufbau, Inhalt und wie genau beschreibe ich den Code (wirklich Methode für Methode durchgehen und sagen was sie macht? Letztendlich hat man dafür ja schon die Codekommentare im Code), und ist es dann sinnvoll im Fließtext den Code mit einzubauen, oder nur darauf zu referenzieren?

Wäre cool, wenn Ihr mir ein paar Tipps geben könntet, hab bisher noch nichts passendes gefunden.


Antwort
Zitat
3 Antworten
izebox
Beigetreten: 07.03.2006
PokerStrategist

(Java/php/*)doc erstellen,
Klassendiagramme dazu und ein paar Durchstiche, Mainmethode, grober Aufrufablauf vom UI -> Datenmodell.


Antwort
Zitat
Rho0
Beigetreten: 20.10.2008
PokerStrategist
Antwort
Zitat
grimbadul Themenstarter
grimbadul
Beigetreten: 20.08.2009
PokerStrategist

Danke euch beiden!
Schau mir den link mal an


Antwort
Zitat
Teilen: