hallo..

ich muss auch gerade schwer doku schreiben..

ich hab meine jetzt auch soweit fertig..

mein chef hat sie sich angeguckt und bis auf ein paar kleinigkeiten vom inhalt her und so für ganz gut befunden..

ich glaube ich mache einen riesen fehler..

ich habe meine doku mehr so nach einer erklärung geschrieben.

also was passiert wenn das programm gestartet wird und so..

ich gehe fast gar nicht darauf ein wie ich es erstellt habe mit was und so..

das muss doch aber bestimmt mit rein?!

ich habe mir jetzt mal einige anderen dokus angeschaut und die haben das alle so gemacht.. ich weiss net so richtig was ich machen soll.. nirgends findet man eine klare liste was genau wie rein muss.. das iss doch doof..

was soll ich denn nun genau schreiben.. wie ich es gemacht habe oder wie??

da schreib ich mich ja schekisch wenn ich das alles aufschreiben will..

und wie iss das mit den quellen muessen die auch in die doku?? die versteht ja eh keiner..

Vielleicht hilft dir das ja weiter. Es muss eine Projektdoku geschrieben werden, die den gesamten Ablauf von der Planung über die Durchführung bis zur Abnahme beschreibt. Es soll keine Benutzeranleitung oder Installationsanleitung geschrieben werden.

Ich habe mich dabei an den Phasen, die ich im Projektantrag bei der Zeitplanung angegeben hatte orientiert:

- Vorbereitung

- Planung

- Durchführung

- Test

- Übergabe

grob gesagt.

In der Durchführung habe ich dann beschrieben, was halt gemacht wurde, aber nicht "hier geklickt", "da geklickt", sondern die Konfiguration beschrieben.

Als Quellen habe ich die Bücher und Webseiten, die ich für mein Projekt verwendet habe, genannt.

ja gut das iss ja schonmal nen anfang..

bei der durchführung hab ich so meine probleme..

soll ich jetzt schreiben wie das prog funzt oder wie ich das gemacht habe damit es funzt??

das iss die große frage..

Original geschrieben von mamamia

soll ich jetzt schreiben wie das prog funzt oder wie ich das gemacht habe damit es funzt??

Ich denke, wie es funktionieren soll kommt ins Projektziel oder Sollanalyse oder so (also nicht in die Durchführung). In der Durchführung schriebst Du halt, wie Du's umgesetzt hast...

Hm, ich bin kein Anwendungsentwickler, deshalb fallen mir da gerade nicht die richtigen Worte ein... vielleicht könnte mich jemand ergänzen?

Kurz und schmerzlos: Das ist eine Projektdokumentation, keine Produktdokumentation. Zu beschreiben sind also die einzelnen Projektphasen, nicht die Funktion des Produkts (Programms). Grobe Gliederung:

- Projektziel

- Ablauf- und Ressourcenplanung

- Ist-Analyse

- Soll-Konzept / Pflichtenheft

- Implementierung

- Test

- Übergabe

- Dokumentation

- Projektergebnisse

also muss ich doch schreiben wie ich es in welcher programmiersprache umgesetzt habe.. mit quellcoden und so ?! richtig !?

ach iss das doof..

Ja

hier mal ein auszug aus meiner doku..

bitte mal gucken ob das so die richtige richtung hat..

Original geschrieben von Crow T. Robot

Kurz und schmerzlos: Das ist eine Projektdokumentation, keine Produktdokumentation. Zu beschreiben sind also die einzelnen Projektphasen, nicht die Funktion des Produkts (Programms). Grobe Gliederung:

- Projektziel

- Ablauf- und Ressourcenplanung

- Ist-Analyse

- Soll-Konzept / Pflichtenheft

- Implementierung

- Test

- Übergabe

- Dokumentation

- Projektergebnisse

hmm dies würde ja bedeuten das man kein extra Pflichtenheft anlegen muss, sehe ich das richtig?..wenn ich also einen Punkt Soll-Konzept drin habe brauche ich kein Pflichtenheft..wäre ja auch annähernd das selbe, richtig?

Original geschrieben von iCErAIN

hmm dies würde ja bedeuten das man kein extra Pflichtenheft anlegen muss, sehe ich das richtig?..wenn ich also einen Punkt Soll-Konzept drin habe brauche ich kein Pflichtenheft..wäre ja auch annähernd das selbe, richtig?

[OT]

Steve bist du das??

[/OT]

Original geschrieben von iCErAIN

hmm dies würde ja bedeuten das man kein extra Pflichtenheft anlegen muss, sehe ich das richtig?..wenn ich also einen Punkt Soll-Konzept drin habe brauche ich kein Pflichtenheft..wäre ja auch annähernd das selbe, richtig?

Wie kommst du darauf? Das Pflichtenheft habe ich doch extra noch dazugeschrieben. Ergebnis der Ist-Analyse und des Soll-Konzeptes ist das Fachkonzept, das in Form des Pflichtenheftes dokumentiert wird.

Original geschrieben von mamamia

[OT]

Steve bist du das??

[/OT]

öhhh.wer da ich höre stimmen???...wenn dann Stev ja;) werdu...schick ma PM;)

@Crow T. Robot

hmm da hab ich das wohl falsch verstanden, da du ja schriebst - Soll-Konzept / Pflichtenheft

naja also ein extra Pflichtenheft in den Anhang...oh man das wird knapp:(