SOFTWAREDOKUMENTATION
-
Hallo Forum,
ich habe inzwischen meine erste Software entwickelt und wage mich nun an die Softwaredokumentation ran.
Ein wunderbares Tool hierfür ist doxygen.
und schon habe ich eine rtf.datei die mir eine schicke Doku ausgibt
(Ergänzungen hinsichtlich der Beschreibungen der einzelnen Funktionen müssen selbstverständlich noch implementiert werden)Nun meine Frage :
Da ich eine vollständige Softwaredokumentation mir als Ziel gesetzt habe, welche punkte müssen in einer Softwaredokumentation noch enthalten sein.
Vielleicht hat der eine oder andere ein paar Tips und Vorschläge für mich.
Thanks schonmal im voraus
Gruß
-shader76-
-
shader76 schrieb:
Da ich eine vollständige Softwaredokumentation mir als Ziel gesetzt habe, welche punkte müssen in einer Softwaredokumentation noch enthalten sein.
schau einfach, was du brauchst, wenn du dich in fremde software einarbeiten sollst.
- ein tutorial, was dem lerner einen guten einsteg bringt. mit beispielen.
- die todo-liste
- (und als wichtigen teil davon) die known-bugs-liste
- guten code brauchste nicht zu dokumentieren, doxygen kannste ruhig wieder löschen
- history (mit begründungen bei designentscheidungen)
-
Ganz wichtig scheint mir die Dokumentation der Anwendungsarchitektur... Welches Objekt, wofür?
-
volkard schrieb:
ein tutorial, was dem lerner einen guten einsteg bringt. mit beispielen.
Klingt für mich etwas akademisch. Beispiele wofür denn? Wenn die Anwendung fertiggestellt ist, scheint es mir reichlich sinnlos, künstliche Problemstellungen zu entwerfen um Beispiele zu liefern.
Und um zum Beispiel Fehler zu suchen, helfen dir Beispiele vermutlich gar nicht weiter... oder reden wir hier von Beispielen zum Debuggen?
-
junix schrieb:
Klingt für mich etwas akademisch. Beispiele wofür denn? Wenn die Anwendung fertiggestellt ist, scheint es mir reichlich sinnlos, künstliche Problemstellungen zu entwerfen um Beispiele zu liefern.
Bei ner Anwendung mag das sein. Bei ner Library macht das auf jeden Fall Sinn. Oder wenn die Anwendung so gebaut wurde, daß bestimmte Dinge erweitert werden können, dann wäre ein einfaches Beispiel, das zeigt wo man dafür hinfassen muß auf jeden Fall gut.
-
Ok, bei ner Library ist das unbestritten ein Vorteil. Bei der erweiterbaren Anwendung hätte ich jetzt behauptet, das sollte sich aus der Architektur sowie deren Dokumentation/Beschreibung erschliessen.
-
junix schrieb:
Bei der erweiterbaren Anwendung hätte ich jetzt behauptet, das sollte sich aus der Architektur sowie deren Dokumentation/Beschreibung erschliessen.
Klar sollte es das. Aber ein Minimalbeispiel, das zeigt wie man was ganz einfaches hinzufügt finde ich auch Hilfreich.
-
wow da habe ich aber eine diskussion angezettelt
nun erstmal vielen dank für die antworten, hat mir definitv weitergeholfen ausser dass ich doxygen löschen soll, gefällt mir nämlich ziemlich das gut das tool und denke das wird mir auch bei der doku weiterhelfen.
gruß
-shader76-
-
Jester schrieb:
Aber ein Minimalbeispiel, das zeigt wie man was ganz einfaches hinzufügt finde ich auch Hilfreich.
Gut, dann sind wir uns ja einig
