PAP in Doku oder Anhang? (FIAE)

[peyote]

Hallo!

Ich sitz gerade an meiner Doku und habe noch ein paar Fragen:

Ich erstelle ja ein (bzw. mehrere) PAPs zum Programmablauf. Gehören die dann direkt in die Doku oder in den Anhang?

Ach ja, gehört nur eine Zeitplanung oder auch eine art Tagebuch in die Doku?

Schreib ich das lieber in der ICH-Form (wie es uns unsere Lehrer raten, da sonst der Eindruck entsteht, man hätte es nicht selbst gemacht) oder lieber allgemein?

Vielen vielen Dank

Andreas

[Akku]

Wenn die PAPs im Kontext mit dem gerade geschriebenen stehen, in die Doku, ansonsten in den Anhang.

Folgende Aussagen nur für die IHK-DO:

Resoucen/Zeitplanung sowie Tagebuch in der Doku erforderlich. Ich Form grenzwertig, jedoch kein Punkabzug, da wir auch der Meinung sind, das in bestimmten Fällen Sätze wie:"Es wurde entschieden Eclipse ..." oder "Die Entscheidung fiel zu gunsten Eclipse weil...", nicht klar die Eigenleistung erkennen lassen.

Also: Telefon, deine IHK wählen, Fragen, Handeln, Freuen, OK?

[Haymaker84]

das sind jeweils große Pläne, die je nach umfang ne ganze Seite einnehmen.

Wenn du auch unter der Bedingung atrbeitest, das deine Doku die 10 Seiten nicht überschreiten sollte, MUSST du die dinger quasi in den Anhang stecken, weil dir der Platz fehlt.

ICh habe bis jetzt immer gehört, dass man das "ich" auf jeden Fall vermeiden sollte, weil es zu unprofessionell klingt. Teilweise ist es sogar verpönt

[peyote]

So.. Vielen Dank erstmal.

Ich habe also mal bei der IHK München / Oberbayern angerufen. Dort wurde mir gesagt, dass ein Projekttagebuch in der Doku nicht gefordert wird, im Anhang aber nicht schaden kann. Des Weiteren wurde mir ausdrücklich gesagt, dass die Doku in der ICH-Form geschrieben werden sollte, da daraus hervorgehen soll, dass ich das Projekt, sowie die Doku, erstellt habe.

So unterschiedlich ist das also.

Gruß

Andreas

[peyote]

Huhu,

eine Frage hätte ich noch:

Soll ich direkt mit der Tür (dem IST/SOLL Ansatz) ins Haus (in die Doku) fallen, oder erst einmal eine Einleitung schreiben?

Bei mir ist das nämlich ein WebProjekt (Kundenprojekt), welches im Rahmen eines Oberprojekts (welches eben mehrere Teilprojekte besitzt) entwickelt wurde.

PS: Da eigentlich keine sooo innovativen Codestellen (ASP .Net 2) vorhanden sind, würde ich auch keinen Code in der Doku angeben. Was meint ihr?

DANKE

Andreas

[Karl Nickel]

Ich habe auch ein Webprojekt als Abschlussprojekt. In meiner Doku habe ich gar keine Programmablaufpläne, sondern beschreibe nur die Funktionen. Wie auch immer, ich denke, sowas gehört in den Anhang. Eine Einleitung würde bzw. habe ich gemacht. Ein Vorwort, was es beim Lesen zu "beachten" gibt oder besser gesagt, was hervorgehobene Wörter und Fußnoten genau bedeuten (Quellen und Erläuterungen im Glossar). Dann ein kurzes Firmenprofil, seit wann es die Firma gibt, womit wir unser Geld verdienen und von dort aus habe ich praktisch einen fließenden Übergang zum Ist-Zustand gemacht. Liest sich IMHO sehr nett

HTH

[edit]

Quellcode muss man keinen Angeben, es sei denn, du willst ihn irgendwie dokumentarisch verwenden. Ich zum Beispiel habe eine Klasse aus meinem Programm gepickt und zeige an ihr beispielhaft den Vorteil von OOP und Dokumentation von Quellcode. Sicherlich auch nicht innovativ, aber ganz informativ. Allerdings glaube ich nicht, dass die Prüfer heiß auf Quellcode sind...

[peyote]

Danke für die Antwort.

Sagt mal, welche Schritfgröße, -art und welchen Zeilenabstand habt ihr denn so verwendet?

Danke!

[Karl Nickel]

Gibt die IHK in der Handreichung vor (im Zweifelsfall anrufen). Bei uns wird 11 Punkt Schriftgröße (Schriftart beliebig) und anderthalb Zeilen Abstand verlangt - ist rießig und habe etwas weniger verwendet. Seitenränder sind links 2,5cm und rechts 1,5cm...

HTH