Softwaredokumentationen erstellen

M

Meik1988

0
moin,

ich habe vor, ein Programm zu schreiben, das etwas umfanreicher wird.
Ich habe mir natürlich schon Gedanken gemacht, was ich machen möchte und will dies, damit ich es nicht vergesse, irgendwo aufschreiben.
Ich denke, die spätere Softwaredoku würde sich dafür anbieten (ToDo-Liste + Doku in einem Dokument).

Leider weiß ich aber nicht, wie man eine Softwaredoku erstellt.
Wie schaut's aus mit der Struktur. Wie geht man eine Softwaredoku an, was muss man beachten. Wie beschreibt man verschiedene Klassen/Module etc.?

Viele Fragen...
Ich hoffe, es kann mir jemand von euch helfen. :)

Leider habe ich bis jetzt keinen Leitfaden oder Regeln o.ä. zur Softwaredoku gefunden.
Ich hoffe, es kann mir jemand von euch sagen, wie ich da rangehe ;)

?dit: Gibt es Tools, die mir die Dokumentation erleichtern? Dabei suche ich keine Tools, die mir aus dem Quelltext die Dokumentation bilden. Da ich das zum ersten mal mache (und auch lernen will), würde ich das gerne selbst machen.

Wie dokumentiert man Datenbanken hinter Anwendungen?
 
Es gibt verschiedene Software-Dokumentationstools. Die erstellen dir aus deinen Kommentaren im Quellcode komplette Dokumentationen zu allen Programmteilen (teilweise mit Verwendung von Variablen im Programmverlauf, Funktionsaufrufe und deren Rückgabewerte, Dateizugriffe, usw...).
Für C++ kenne ich da Doxygen.
Kommt halt auf die verwendete Sprache an.

//Edit
Ich habe gerade zufällig per Google noch Unterlagen aus einer Vorlesungen gefunden, der ich vor Jahren mal beiwohnen durfte. *g*
Is zwar nur ne PowerPoint-Präsentation, aber vielleicht liefert es dir ja ein paar Anhaltspunkte, wie man vernünftig dokumentiert.
;)

http://graphics.cs.uni-sb.de/Courses/ws0203/Sopra/folien/dokumentation.pdf
 
Also im Grunde sollte eine Software Doku so aufgebaut und gestaltet sein, dass ein zweiter nach lesen deiner Doku die Software ändern anpassen und vertsehen kann.
ein paar Stichpunkte:
-UseCase Diagramm
-ActivitätsDiagramme
-VerlaufsDiagramme
-Minimal Anforderung
-Maximal Anforderung
-Quellcode
-Bedienungsanleitung
-Beschreibung eventuell genutzter Tools
-Beschreibung eingesetzter Tools zur Entwicklung
-Indexer (Verweise, Links etc.)

Ich muss mal kramen ob ich noch meine aus meinem SchulProjekt finde...

Greetz
 
wenn mehrere daran arbeiten sollen kann ich wärmstens dokuwiki empfehlen ;)
Damit arbeite ich zur Zeit zur Dokumentation an drei Projekten und es ist einfach genial...
 
@knoxx: ich suche kein Programm, das mir aus den Kommentaren im Code eine Doku bastelt (den Hinweis auf Doxygen habe ich schon gefunden).

Die Präsentation sieht schon besser aus. Die werde ich mir mal anschauen.

@q9fx7: Ich habe auch schon überlegt, Dokuwiki dafür zu nutzen.
Weiß dann aber nicht, wie ich die Struktur aufbauen soll. Darf ich mir einer der Dokuwikis mal anschauen, die du gerade benutzt?

Wie schauts denn mit Datenbanken aus?
Dokumentiert ihr die auch?
 
Um antworten zu können musst du eingeloggt sein.
Zurück
Oben