Softwaredokumentation

[Patrick B. (p51d)]

Hallo

Ich habe bis jetzt schon ein paar Projekte realisert und auch an 
grösseren mitgearbeitet. Anschliessend habe ich mich bei einem Studium 
angemeldet, in dem wir wieder bei 0 anfangen. In einer Gruppe mussten 
wir ein Softwareprojekt erstellen. Konzeptionierung, Analyse, Design, 
Implementierung und Test waren die entsprechenden Schritte.
Nun wurde die Aufgabe erweitert: Wir müssen noch ein entsprechende 
Dokumentation dazu schreiben. Bis jetzt habe ich hier nie wirkich ein 
standartisiertes Modell gefunden. Gibts das überhaupt?
Bei einer Suche war ich auf die IEEE Variante gestossen, nur fällt es 
mir schwer das alles in ein einziges Dokument zu bringen.

Was gibt es für Standarts oder dementsprechende Templates?

Besten Dank
Patrick

[Karol B. (johnpatcher)]

Mir stellt sich in erster Linie die Frage was genau du überhaupt 
dokumentieren möchtest/musst. Den Verlauf des Projekts? Die entstandenen 
Module bzw. Schnittstellen? Den Quellcode selbst (in welcher 
Ausführlichkeit?

Für den Quellcode bietet sich Javadoc & Konsorten an. Im Umfeld von C 
wäre das Doxygen. Ansonsten geht es wohl eher in die Richtung "(fast) 
beliebig, aber konsequent". Allerdings würde ich mich eher mal mit euren 
Betreuer(n) in Verbindung setzen. Die sollten wissen was sie erwarten 
und können euch ggf. Arbeiten aus den Vorjahren oder so zugänglich 
machen.

Mit freundlichen Grüßen,
Karol Babioch

[Patrick B. (p51d)]

Der Code selber wird über Doxygen kommentiert.

Eigentlich soll das ganze Projekt mit dem Ablauf und allem Dokumentiert 
werden (Zeitplan, Verantwortungen, Design-Analysen, Testfälle, Fehler, 
Pflichtenheft...)

Das Problem dabei ist, dass uns der Lehrer eine Dokumentation gezeigt 
hat, aber explizit keine Anleitung oder Musterlösung abgeben möchte. Und 
da ich von meinen Industrieerfahrungen weiss wie ein Projekt umgesetzt 
wird, hatten wir hier keine Probleme. Nur die Dokumentation war immer so 
ein "Wischiwaschi"-Part ohne explizite normierung. Es war überall und in 
jedem Fall wieder anders...

[Karol B. (johnpatcher)]

Patrick B. schrieb:
> Nur die Dokumentation war immer so
> ein "Wischiwaschi"-Part ohne explizite normierung. Es war überall und in
> jedem Fall wieder anders...

Zumindest ich kenne das auch so. Habe in dieser Beziehung auch schon 
vieles gesehen (bzw. anfertigen müssen). Unter anderem z.B. ganz 
"klassisch" ausformulierte Dokumente mit Word bzw. LaTeX, 
Zeitpläne/Diagramme mit irgendwelchen Tabellenkalkulationen und auch 
Präsentationen, die alles Wesentliche zusammenfassen.

Ich bezweifle stark, dass es (gerade bei einem Uni-Projekt) eine 
"universal richtige" Antwort (TM) gibt. Das hängt zu stark vom Lehrstuhl 
und Betreuer ab. Ich persönlich habe immer die besten Erfahrungen damit 
gemacht, wenn man "einfach mal anfängt" und später dann ein wenig mehr 
Struktur und Form herein bringt. Da ihr mehrere Leute seid, könnt ihr 
das ja auch alles schön besprechen. Ansonsten den Betreuer nach 
"unverbindlichen" Tipps fragen bzw. ihn bitten sich das im Vorfeld mal 
anzusehen.

Es gibt auch einen Wiki Artikel [1], der auf diese Thematik eingeht und 
entsprechende DIN-Normen nennt. Vielleicht kann man sich ja dort 
inspirieren lassen?

Mit freundlichen Grüßen,
Karol Babioch

[1]: https://de.wikipedia.org/wiki/Projektdokumentation