proggen.org

Hallo,
Ich suche verzweifelt ein Dokumentationstool / Hilfesystem zur Dokumentation unserer Produktentwicklung (aber kein Wiki!! ), welches folgende Eigenschaften besitzt:

Die Sourcefiles sollten Plaintext und somit SVN(-diff-)faehig sein
Die Plaintext-Daten sollte nicht immer an der gleichen Stelle beispielsweise einen Timestamp aendern (SVN-Konfliktgefahr)
Die Ausgabeformate CHM, HTML und PDF waehren wuenschenswert

Ich habe relativ viele Tools zur Erstellung von Hilfeseiten durch Googeln gefunden.
Diese legen allerdings die Dateien in ihren Projektordnern in allenmöglichen Formaten ab, nur nicht in Plaintext(xml, html oder anderes).
Dies ist ein wichtiges Kriterium, da wir mit vielen Leuten gleichzeitig an der Dokumentation unserer Produktentwicklung arbeiten.
Es wäre schon, wenn jemand einen Tipp für mich hätte.

Cspnnn

cspnnn hat geschrieben:Hallo,
Ich suche verzweifelt ein Dokumentationstool / Hilfesystem zur Dokumentation unserer Produktentwicklung (aber kein Wiki!! ), welches folgende Eigenschaften besitzt:

Die Sourcefiles sollten Plaintext und somit SVN(-diff-)faehig sein
Die Plaintext-Daten sollte nicht immer an der gleichen Stelle beispielsweise einen Timestamp aendern (SVN-Konfliktgefahr)
Die Ausgabeformate CHM, HTML und PDF waehren wuenschenswert

Ich weiß nicht, was genau Du dokumentieren möchtest, aber ich benutze bei meinen Projekten Doxygen (und auch SVN).

HTML geht auf jeden Fall, PDF geht wenn ich mich recht entsinne auch und CHM gehört glaueb ich auch dazu.
Mit Doxygen dokumentierst Du a) direkt im Sourcecode und b) in beliebigen (Plaintext)-Dateien.
Bisher war es bei mir nicht nötig, Quellcodeunabhängige Seiten zu erzeugen, aber ich kann mir gut vorstellen, dass es das auch kann.
Was mir gefällt ist, dass doxygen automatisch Grafiken zu den Objektbeziehungen erzeugt.

cspnnn hat geschrieben:Ich habe relativ viele Tools zur Erstellung von Hilfeseiten durch Googeln gefunden.
Diese legen allerdings die Dateien in ihren Projektordnern in allenmöglichen Formaten ab, nur nicht in Plaintext(xml, html oder anderes).
Dies ist ein wichtiges Kriterium, da wir mit vielen Leuten gleichzeitig an der Dokumentation unserer Produktentwicklung arbeiten.
Es wäre schon, wenn jemand einen Tipp für mich hätte.

Sofern Du Doxygen noch nicht hattest, tada...

Xin hat geschrieben:HTML geht auf jeden Fall, PDF geht wenn ich mich recht entsinne auch und CHM gehört glaueb ich auch dazu.

Genau, zusätzlich werden auch noch LaTeX, PostScript, RTF, Manpages und XML unterstützt. Da sollte also für jeden das richtige Format dabei sein.

Xin hat geschrieben:Bisher war es bei mir nicht nötig, Quellcodeunabhängige Seiten zu erzeugen, aber ich kann mir gut vorstellen, dass es das auch kann.

Ja, auch das ist möglich.

Xin hat geschrieben:Was mir gefällt ist, dass doxygen automatisch Grafiken zu den Objektbeziehungen erzeugt.

Nicht nur das. Man kann auch selbst die verschiedensten Diagramme und mathematischen Formeln setzen.