Programmiererdokumentation

Hallo zusammen, ich müsste eine doku über ein bereits bestehendes programm schreiben.

Da ich keine Ausbildung bzw studium in diese richtung habe weiss ich nicht, was
eine doku dieser art alles beinhalten sollte.

- uml
- normen z.b für die berechnung
- kurze erläuterung einzelner funktionen

Ich bitte um tips!!

C++ Forumbot

Dieser Thread wurde von Moderator/in Martin Richter aus dem Forum MFC (Visual C++) in das Forum Rund um die Programmierung verschoben.

Im Zweifelsfall bitte auch folgende Hinweise beachten:
C/C++ Forum :: FAQ - Sonstiges :: Wohin mit meiner Frage?

Dieses Posting wurde automatisch erzeugt.

nman

Das laesst sich so pauschal nicht beantworten. Fuer wen soll die Doku da sein? Interne Entwickler? Endanwender? Entwickler bei Drittfirmen bzw. Entwickler die ein API verwenden? …

Es soll wohl in die richtung gehen, dass ein programmierer von einer externen firma genau weisd was zu tun ist (vlt wegen der kompatibilität)

Dklay schrieb:

Es soll wohl in die richtung gehen, dass ein programmierer von einer externen firma genau weisd was zu tun ist (vlt wegen der kompatibilität)

Kriegt er den Quellcode?
Wenn ja, dann wäre eine Beschreibung des Quellcodes in UML das richtige.

Falls nein, dann wäre eine Funktionsbeschreibung der öffentlichen (public) Funktionen, Methoden und Schnittstellen die richtige Wahl.
Dafür gibt's dann so Tools wie Doxygen. Bei Java Anwendungen gibt's dafür was, das dem JDK beiliegt.

ABer viel mehr frage ich mich, warum man jemanden so etwas schreiben läßt, der davon keine Ahnung hat? (nicht blöse gemeint)

Um die UML zu verstehen sollte man nämlich auch Programmieren können, für die Beschreibung von Funktionsnamen sollte man ebenfalls wissen was man tut.
Und die UML will auch noch gelernt sein.