Effiziente Dokumentation der Entwicklungen

[Antibiotik]

Hallo zusammen,

ich habe in unserer Firma folgende Ausgangssituation:

Die Dokumentation der Entwicklungen (Methoden und Klassen im Quellcode, Solutions und Grobarchitektur in Word, etc.) ist nicht sonderlich effizient. Zu einem erfolgt die Dokumentation an unterschiedlichen Stellen (Quellcode, Entwicklungsbeschreibung, …) zum anderen geht sehr viel Zeit für die optische Aufbereitung der Doku drauf. Weiterhin ist die Suche nach gewünschter Information aufgrund der unterschiedlichen Quellen relativ aufwendig.

Habt Ihr Erfahrungen wie die Dokumentation der Entwicklungen vereinfacht werden kann?

Bei uns im Team wurde der Vorschlag gebracht, eine Art Wiki aufzubauen. In diesen Wiki könnten dann automatisch die Kommentare aus dem Quellcode rein fließen, den anderen Teil würden dann die Entwickler verfassen.

Ist dass ein machbarer Weg?

Danke

Ciao

Antibiotik

[russkij]

hi, wir verwenden doxygen,

doxygen wikipedia

ist super praktisch.

die kommentare im quelltext müssen einen bestimmten format aufweisen, der aber sehr einfach ist und leicht zu erlernen ist.

Diese werden dann vom doxygen ausgelesen und automatisch verlinkte htmls generiert. hier ein beispiel so einer automatisch generierten dokumentation:

Xerces-C++: DocumentHandler Class Reference

es lohnt sich, mal genauer rein zu schauen.

gruss

[Healthy]

Hallo,

Microsoft Visio wäre auch eine Alternative.