Beschreibung/Doku erstellen

[roger]

Hallo,

ich möchte gerne zu meinem Projekt eine Beschreibung/Doku erstellen.
Da ich ausser Schmierzettel keine Ahnung von Art und Weise habe, bitte ich hier um Info bzw. Erfahrungen mit dem erstellen von Doku.

1. Programm sollte unter Linux/Win laufen.
2. In der Doku möchte ich links/Verweise erstellen können, um in der Doku hin und her springen zu können.

3. Eine Art Diagramm / Aufrufhierachie der einzelnen Funktionen/Lib sollte ebenfalls möglich sein.

Vielleicht hat jemand ein kurzes PDF um zu sehen, wie so etwas aussehen könnte.

Bin für jede Info/Tip dankbar

Gruß
          roger

[T-Rex]

• yEd ist ein schöner Editor für Diagramme.
• PHPdoc / JAVAdoc (hab ich aber bis jetzt noch nicht selber benutzt)

Für MySQL gibts da noch die Benchmark Tools. Dabei ist ein ERM Diagramm Dingends. Der erstellt dir aus einer existierenden Datenbank ein ERM Diagramm und aus einem ERM Diagramm eine Datenbank mit entsprechenden Tabellen.

Wie soll sowas aussehen?
Dokumentation dient dazu, dass man etwas verständlich "erklärt" bzw. hinterlegt. Wenn in deiner Firma bzw. bei deinem Projekt jeder mit Strichmännchen zufrieden ist, dann male Strichmännchen!

Gruß
(Dokumenten Ersteller)
T-Rex