PDA

Vollständige Version anzeigen : Wie dokumentiere ich eine Softwareprojekt


VerdammtBlödeAufgabe
01.04.2007, 11:55
Hi, nach einigen Problemen, welche zum Teil auch hier gelöst wurden ist mein Softwareprojekt nun fast fertig, Danke noch mal.

Jetzt geh es an die Doku, leider weiß ich nicht genau was da so gefordert ist und wie man es richtig macht.
Die Doku soll sowohl einen technischen Teil als auch einen generellen Teil über die Benutzung der Software enthalten.
Anleitung ist kein Problem aber wie muss ich z.B. eine Klasse und deren Methoden beschreiben, Flussdiagramm, UML, PAP ???

Danke schon mal

rayek
04.04.2007, 14:05
hi, vba.
mich würde erstmal interessieren, wofür du das brauchst ;) ?
ist das für den kunden, oder machst du auch grad dein IHK-abschlußprojekt? :D
wenn ersteres der fall ist, würde ich auf jeden fall die doku aufteilen in a) das pflichtenheft und b) das benutzerhandbuch....
rayek

Texas3110
17.05.2007, 11:56
Hey

Ich möchte mich mal an die Frage anschließen. Für eine Laborarbeit (einen Scanner in C++ programmieren) muss ich eine Dokumentation erstellen. Die Doku soll eine Erklärung des Cods und der Herangehensweise an die Aufgabe beinhalten sowie UML Diagramme. Die UML Diagramme kann ich mit MS VISIO erzeugen. Was ich mir wünschen würde das ich aus Visual Studio heraus per Mouse Klick direkt ein Klassendigramm von Visio erstellen lassen kann. Geht das und wie mache ich es?

Viele Grüße
Stefan