Richtlinien für die Dokumentation
-
Bisher habe ich die Dokumentationen für meine Programme immer ziemlich formlos geschrieben. Dadurch gab es auch jedes Mal unterschiedliche Gliederungspunkte.
Jetzt möchte ich gerne auf ein System umsteigen, das ich dann für jedes zukünftige Projekt nuzten kann, so dass die Dokumentationen einigermaßen einheitlich werden.Dazu habe ich die folgende Richtlinie gefunden:
http://ib.ptb.de/pls/portal/docs/PAGE/IB_PTB/8/85/851/SPS/SWQ/DOC/drl/PTB-8.51-AD01-Doku-V30.pdfDas scheint mir sinnvoll zu sein, es basiert zudem auf einer DIN-Norm.
Bevor ich damit loslege wollte ich aber doch mal fragen, wie ihr das macht. Nutzt ihr auch so eine "globale" Richtlinie, oder gibt es da firmenintern vielleicht speziellere Herangehensweisen?
-
Du kannst dir auch das Buch Producing Open Source Software durchlesen, das behandelt u.a. das Dokumentieren sehr ausführlich.
-
Eine Frage noch zu diesem Thema:
Mit welchem Programm erstellt man am besten Ablaufdiagramme?
Ich meine so etwas wie in dem oben verlinkten PDF auf Seite 39 und 40.
-
Bist auf dem falschen Dampfer. Mit Programmablaufplänen kannst Du Programme nur bis Basic/C/Pascal ohne Objektorientierung darstellen. Außerdem treiben heilige Regelwerke im Informatikgeschäft die Qualität in Richtung Mittelmaß.
-
Ich will ja nicht das ganze Programm in einem Ablaufplan darstellen, sondern nur einzelne Algorithmen. Und für die finde ich das durchaus sinnvoll.
Es kann natürlich sein, dass es kein festes Regelwerk gibt, das man für Dokumentationen nutzen sollte... ich habe so etwas nur noch nie ernsthaft gemacht, darum wären ein paar Anhaltspunkte nicht schlecht, damit ich nichts wichtiges vergesse.