Entwicklungssoftware Dokumentation

[Fatjoe]

Hallo zusammen,

ich habe vor ca. 6 Monaten eine Stelle als Softwareentwickler angenommen und bin eigentlich täglich damit konfrontiert, dass ich meine Aenderungen an einem vorhanden Code dokumentieren sollte. Es wird ausschliesslich C verwendet und so habe ich mir sagen lassen fallen die üblichen Techniken weg, da gerade die Tools sehr Klassenorientiert verwendet werden.

Jetzt wollte ich nachfragen ob mir jemand eine Buchempfehlung machen könnte. Das Buch sollte mir zeigen können wie bestehende Softwareteillösungen dokumentieren, die Theorie hinter der Implementierung und vorallem sollen meine Aenderungen ebenso erklärt werden.

Bisher habe ich den die alten Code Stellen kopiert und bezeichnet. Eine weitere Tabelle wurde mit den Aenderungen versehen. Jedoch fehlt mir etwas eine Uebersicht wie ich das gesamte Dokument verfassen soll. Also Goals, Software Stand vor Aenderung, nach Aenderungen etc.

Besten Dank
Fatjoe

 

[below]

Ich kann nur mal diesen Link in die Diskussion werfen:

C++ Programming Style Guidelines

Alex

 

[Fatjoe]

Danke,

aber wir verwenden unsere eigenen Coding Rules, sowie Misra. Ein Buch Tip wäre Klasse.

 

[Fatjoe]

keine Tips mehr=?

 

[MatzeLoCal]

Was spricht denn gegen Doxygen als Tool?

 

[Fatjoe]

Doxygen verwenden wir bereits.

 

[Sir Q]

Also Goals, Software Stand vor Aenderung, nach Aenderungen etc.

Hmm - meinst du vieleicht sowas wie Subversion?