Dokumentation schreiben

[Metua]

hi leute,

hat einer von euch vielleicht nen guten link zu Dokumentation-technik.

Den Aufbau betreffend.

thx a lot

met

[Merlin_Level_E]

iLoha Metua,

definiere mal genauer was du nachher haben möchtest.

Benutzerhandbuch, Systemdoku, Guideline for Dummies oder sowas in der Richtung ?

Möchtest du JavaDoc mit unterbringen ? Source oder Comments ?

iGruß,

Moi

[Jaraz]

Hi,

eine Möglichkeit sein Java Programm bzw. seine Bibliothek zu dokumentieren, ist mit Maven möglich.

http://maven.apache.org/

Gruß Jaraz

[Metua]

iLoha Metua,

definiere mal genauer was du nachher haben möchtest.

iGruß,

Moi

Ich habe ein Javadoc erzeugt und möchte noch eine kleine Dokumentation schreiben.

Beweggründe, Anforderungen, benutzte Software...also alles das, was ich im javadoch nicht untergebracht habe. Das Javadoc hänge ich an diese Doku mit ran. Ich bräuchte eigentlich mal so einen allegemeinen Bauplan für Dokus im IT-Bereich...ähm, glaub ich...

grüße met

[remopeter]

Am besten, du benutzt Doxygen für die javadoc und Latex für weitere ausführungen. du kannst doxygen in deine Latex dokumente integrieren.

Doxygen HP: http://www.stack.nl/~dimitri/doxygen/

LaTeX HP: http://www.texniccenter.org/front_content.php Hier findest du auch einen super editor für windoof. in suse linux gibt es den editor 'Kile'. unter linux bräuchtest du auch nichts runterzuladen. da ist alles auf der dvd drauf was du brauchst.

um mit latex zu arbeiten musst du dich ein bisschen einarbeiten. es lohnt sich aber auf alle fälle. alle word probleme mit zu langen dateien, absturz, formatierung usw fallen bei latex weg....