Dokumentation/Pflcihtenheft

Computer: Software & Programmierung Programmierung allgemein
#1

Hallo,
erstmal http://www.hdvo.de ist mir bekannt *g* also die Archivsuche war nicht erfolglos…

Nun zu meinem eigentlichen anliegen.
was kommt ins pflichtenheft, was in die doku, was ist wie aufgebautß
wo kommt der quellcode rein, wo dazugehörige kommentare, oder die kommentare direkt im quellcode implementieren, gibt man irgendwo an wie lange welcher teilbereich gedauert hat zu erstellen?

Hat jemand vielleicht eine Vorlage, oder ein fertige zur Ansicht??? die er/sie mir zukommen lassen könnte?
Momentan noch von privater Bedeutung, aber wohl für meine Ausbildung später wichtig…

Wäre klasse…

Danke und Gruß

Marcel

#2

Hallo Marcel,

Das ist nicht so einfach zu beantworten weil es von Projekt zu Projekt unterschiedlich ist.

Im Prinzip ist das Pflichtenheft eine Forderung des Kundens, in der Dokumentation beschreibst du dann deine Lösung.

Diesselbe Aufgabenstellung kann oft in einem 10seitigen Pflichtenheft und in einem 100seitigen Pflichtenheft beschrieben sein. Ersteres läßt dir als Auftragnehmer halt dementsprechend mehr Freiheit.

Der Umfang und die Qualität der Dokumentation kann auch stark variieren. Ansich sollte die geforderte Dokumentation im Pflichtenheft oder im Vertrag zwischen Kunden und Anbieter festgehalten werden. Damit vermeidest du Konflikte im nachhinein.

Zu der Doku im Source, das gehört eigentlich auf jeden Fall dazu. Trotzdem sollte man sie bei Vertragsabschluss irgendwo erwähnen, das natürlich auch wieder in der Qualität stark variieren kann.

Die Doku im Source beschreibt aber nur was an einer bestimmten Stelle jetzt genau passiert. Eine Beschreibung der Systemarchitektur, Datenmodelle, Installationshandbuch, Benutzerhandbuch etc. etc. kann das aber nicht ersetzen.

Grüße, Robert

#3

Lastenheft/Pflichtenheft

Im Prinzip ist das Pflichtenheft eine Forderung des Kundens,
in der Dokumentation beschreibst du dann deine Lösung.

Da muss man vorsichtig sein. Das Lastenheft beschreibt die Forderungen des Kunden, das Pflichenheft die Realisierung der Technischen Details. Das Pflichtenheft ist also hauptsächlich für das Projektteam, da der Kunde mit den Daten des Pflichtenheft nichts anfangen kann. Die umgangssprachliche Beschreibung findet sich dann im Lastenheft, welches dann auch meistens mit dem Vertrag verknüpft ist.

Der Quelltext wird nicht explizit in eine Dokumentation aufgenommen, wenn es sich nicht gerade um spezielle komplexe und zentrale Funktionen handelt. Die Kommentare sollten (in Englisch) direkt im Quelltext erfolgen. Hier entsteht dann ien Dilemma: Wenn man die Kommentare au dem Quelltext in eine Dokumentation aufnimmt, findet man diese vom Quelltext nicht mehr wieder, andersrum sollten in einer Entwicklerdokumentation aber alle Module und Funktionen beschrieben sein. Hier ist nun abzuwägen, wie viel in den Quelltext geschrieben wird, wie viel in die Dokumentation, wobei Doppelarbeiten natürlich zu vermeiden sind…

Ralph

#4

Ja,

das Lastenheft geht zu Lasten des Kunden/Projektes. Das Pflichtenheft beschreibt die Pfichten des Entwickler, die Anforderungen des Kunden zu erfuellen bzw. umzusetzten. Ich bin mittlerweile dazu uebergegangen, alles in einem Dokument zu erfassen, was sich dann bei mir URS/AURS nennt (User’s Requirement Specification / Answer to URS). Das wird dann unterzeichnet und gegengezeichnet. Die technischen Details werden dabei nicht genauestens beschrieben, da der Kunde es entweder nicht genau wissen will oder was damit anfangen kann.

Die technische Beschreibung fuehre ich auch speziell im Source Code während der Entwicklung aus und generiere damit automatisch eine Dokumentation via Doxygen Tool. Dies ist praktisch, da sich während der Implementierungsphase bei mir oft die Details der Umsetzung ändern, die Doku dabei aber jedesmal wieder via Knopfdruck neu generiert werden kann. Globales Design bleibt meist erhalten und ist bei mir nur über Rose oder Visio verfuegbar.

Ciao

#5

Hallo Marcel,

freut mich, dass Du HDvO als Quelle gefunden hast!
Die Frage nach der Differenzierung zwischen Pflichtenheft und Dokumentation stellt sich eigentlich nicht. Meine Erfahrung hat gezeigt, dass wenn die Beschreibung der Prozesse und der Software vorgenommen worden sind, dann ist damit auch gleichzeitig ein großer Teil der Dokumentation fertig gestellt.

Wenn ein Pflichtenheft erstellt wird, dann wird dies immer gemeinsam mit der Fachabteilung bzw. demjenigen erstellt, der die Anforderung stellt. Während der Erarbeitung dieses Teils des Pflichtenhets wird dann soviel Wissen um die Anwendung angehäuft, dass eine weitergehende Dokumentation zumeist nicht notnwendig ist. Erst wenn dieser Teil abgeschlossen ist, dann wird die technische Realisierung dokumentiert.

Aus diesem Grunde kamm man eigentlich sagen, das der Quellcode bzw. die meisten technischen Details den Auftraggeber nur am Rande (wenn überhaupt) interessieren. Diese Informationen sind nur für den Entwickler wichtig. Ich würde daher die techischen Detail grundsätzlich von den fachlichen Details trennen.

Gruss
Bernd. . .
http://www.hdvo.de

#6

Besten dank @all, denke damit komme ich was weiter
owT