Projektdokumentation: Muster/Hinweise?

[snerff]

Ich bin gerade dabei, mein Projekt als FISI abzuwickeln. Aber an die Dokumentation traue ich mich noch nicht so recht ran, da ich nicht genau weiß, wie so etwas aufgebaut sein sollte/muss.

Da ich meine Ausbildung verkürze, werde ich auch in der Berufsschule nicht mehr viel dazu lernen.

Daher meine Frage: Hat jemand von euch ein Muster/eine Patentlösung/eine genaue Vorgabe, was enthalten sein muss, was nicht enthalten sein darf, wie man an so etwas rangehen soll?

Bevor gleich wieder alle :mod: schreien: Ich hab das Forum durchsucht, ich hab in den Download-Bereich geschaut, ich hab die FAQ gelesen. Aus allem kann man ein bisschen was entnehmen, aber wenn jemand eine strukturierte Auflistung hätte, wär ich sehr dankbar. Hier gibt es keine Ex-Azubis, an deren Dokus ich mich orientieren könnte.

Oder vielleicht auch eure Erfahrungen in der Anfertigung einer Doku. Wie fängt man am besten an? Welche Vorlagen habt ihr benutzt? Welche Punkte kommen zuerst? Wie genau sollte man sein? Erklärungen nur in den Glossar oder auch im Text? Während des Projektes grobe Stichpunkte oder direkt alles in die Doku aufnehmen?

Bitte gebt mir mal eine Starthilfe.

[robotto7831a]

Hallo,

schau Dir mal folgendes Buch an.

http://www.amazon.de/exec/obidos/ASIN/380459705X/qid=1093880171/ref=sr_8_xs_ap_i1_xgl/302-5468843-3769665

Dort werden viele deiner Fragen beantwortet.

Frank

[Marco S.]

Hi!

Also als FiSi hab ich bis auf ne kleine Doku für ne 2Tages-Arbeit noch ichts gemacht, aber ich denk der Ansatz is immer das selbe:

zuerst überlegst du dier ne sinnvolle gliederung, sprich was will ich mit reinbringen.

ZIEL - Wichtigster Punkt dabei is imho Die eigendliche Aufgae, bzw. das Ziel das du erreichen willst.

WISSEN - Danach solltest du einen Punkt machen, der das nötigste Wissen vermittelt (z.B. Begriffserklährungen, wozu sind bestimmte Sachen gut und wie(!) verwendet man sie)

DOKU - So und wenn du das hast kannst du das wissen was oben erläutert wurde konkret anwenden. Das wichtigste ist darüber bekannt, also kann mans rel leicht auch als ausenstehender nachvolziehen.

Diesen Punkt kannst du beliebig ausdehnen und aufsplitten, je nachdem wies sinn macht

Zu guter letzt würd ich noch ein FAZIT einbauen, wo probleme bei der Durchführung angesprochen werden, eigenkritik (wie hätte ichs an bestimmten stellen besser machen können) usw.

Das währe so mein Vorschlag, hat sich bei mir auch im rel gut gemacht.

Zum Thema Glossar:

Worterklährungen kannst du da reinstopfen, aber wenns länger wird, dann würde ichs als eigenes Thema unter WISSEN nehmen. (z.B. wofür ist mscdex da, was für parameter gibts, und wie binde ich im allgemeinen damit nen CD-Treiber ein)

Während dem Projekt auf jedenfall Stichpunkte machen, was du bereits gemacht hast, was unter WISSEN soll usw. Ausformulieren würd ich relativ zum schluss machen. da kannst du alles viel besser überschauen und hast nevorstellung wie ausführlich du alles schreiben kannst ohnen deinen rahmen zu sprengen. außerdem hast diu während des projektes vermutlich eh genug zu tun Das einzige was man währenddessen schreiben könnte währe meiner Meinung nach ZIEL und WISSEN, aber auch da muss man dann auf di3 Länge achten.

So, ich hoffe das hilft dir etwas weiter. Ist nun sicherlich nicht die Lösung aller Probleme, hat sich aber wie gesagt bei mir ganz gut bewährt.

MfG

Marco

PS: Fuß und Endnoten machen sich idR verdammt gut ;D

[MBaeuml]

Also als FiSi hab ich bis auf ne kleine Doku für ne 2Tages-Arbeit noch ichts gemacht, aber ich denk der Ansatz is immer das selbe:

Eine 2 Tagesarbeit mit einem Abschlussprojekt zu vergleichen halte ich doch für sehr gewagt...

Der Aufbau ist eigentlich immer gleich:

1. Einleitung/Projektdefinition
   
2. Ist-Analyse
   
3. Soll-Konzept
   
4. Durchführung/Realisierung
   
5. Projektabschluss
   - Test
   
   
   - Abnahme
   
   
   - Reflexion/Fazit

   
   

Das sind die normalen Phasen eines Projektes. So und damit du mal ein Beispiel hast hier mal meine Doku

Link

Waren 87% also nicht top, aber auch nicht schlecht, der größte Fehler war (wie mir ein Prüfer sagte) das ich das Glossar nicht alphabetisch sotiert habe (vergessen, könnte mich dafür heute noch würgen ) und die Darstellung der "verbrauchten" Zeit. Also Glossar ist wie Marco schon sagte wichtig, sollte man also machen und evtl. auch Fußnoten, die machen was her, aber nur wen sie nicht zu lang sind.

Gruß

Marc

[pfc]

Hi MBeuml,

danke für deinen Beispiel post.

Nur kurze Frage vor weg:

In meiner IHK Info, die mir heute zuging, steh fett geruckt:

Die Dokumentation soll einen Umfang von max. 10 DIN A4 Seiten nicht überschreiten.

Du hast 33.

Sehe ich dass richtig, dass man das so aufsplitten kann:

12 Seiten tatsächliche Doku, der Rest, Quellenagaben, und Glossar?

Oder wie setzten sich die 10 Seiten zusammen?

UNd hast du die Doku im .pdf Format abgegeben? bzw wie hast Du Präsentiert?

Auch mit diesem .pdf oder hast du da eine extra Version?

(Also unterscheiden sich Dokumentation abgabe und Projekt präsentation?)

gruß,

pfc

[AlexFIAE]

Du musst zwei ausgedruckte Exemplare deiner Dokumentation am Tag deiner schriftlichen Prüfung abgeben (so war es bei mir IHK Lüneburg/Wolfsburg). Am besten lässt du die Dokumentation binden. Macht einen sauberen Eindruck

In der Präsentation sollst du nicht den Aufbau deiner Dokumentation vorstellen sondern wie du dein Projekt durchgeführt hast. In der Regel erstellt man dafür eine PowerPoint Präsentation.

PS: Neben dem einheitlichen Aufbau solltest du auch auf die Seitenzahlen ein Augenmerk geben. Das Inhaltsverzeichnis gehört nicht mit in die Aufzählung d.h. die erste Seite ist die Seite wo du mit der Dokumentation deines Projektes beginnst.

Mein Projekt wurde mit 98,5% bewertet :marine

[Sandrin]

@pfc

Die 10 Seiten sind warscheinlich ohne Deckblatt, Inhaltsverzeichnis und Ahang gemeint. So macht ist z.B. die IHk Münster.

Gib doch mal bitte deine IHK an, dann kann man dir deutlich besser helfen. Denn jede IHK handhabt das anders.

[robotto7831a]

UNd hast du die Doku im .pdf Format abgegeben?

Deine IHK sagt Dir wie sie es gerne haben möchte. Jede macht es anders.

bzw wie hast Du Präsentiert?

Auch mit diesem .pdf oder hast du da eine extra Version?

(Also unterscheiden sich Dokumentation abgabe und Projekt präsentation?)

Du sollst in der Präsentation nicht deine Doku präsentieren sondern das Projekt.

Frank

[Alde]

Also ganz ehrlich, wenn ich mir so einige Dokus anschaue versteh ich die Welt nicht mehr!!!

Ich hab vor kurzem meine Genehmigung für mein Projekt erhalten, mit dem Zusatz, wie ich meine Doku zumachen habe!

z.B Arial, Schriftgrösse 11, Inhaltsverzeichnis und Überschriften nach DIN 5008 :eek:

Musstet ihr das alle nicht machen???

Alex

[joka]

hallo,

ich musste auch die Vorgaben der IHK einhalten.

IHK Oldenburg.

Arial, Schriftgröße 11, 10 Seiten ohne Deckblatt, Anhang max 5 Seiten und

Zeilenabstand 1,5fach.

man durfte die doku nicht heften oder klammern. ich hab sie in einem spiralding gebunden.

gruß joka

[robotto7831a]

Jede IHK hat da ihre eigenen Regeln wie eine Doku aussehen muss.

Man kann keine IHK miteinander vergleichen.

Frank

[IT2004]

hallo,

ich musste auch die Vorgaben der IHK einhalten.

IHK Oldenburg.

Arial, Schriftgröße 11, 10 Seiten ohne Deckblatt, Anhang max 5 Seiten und

Zeilenabstand 1,5fach.

man durfte die doku nicht heften oder klammern. ich hab sie in einem spiralding gebunden.

gruß joka

10 Seiten Doku+max. 5 Seiten Anhang? Ich dachte schon, dass es bei uns sehr knapp ist. Aber mit insgesamt 15 Seiten wäre ich bei meiner Doku nie ausgekommen. Wir hatten 10 seiten Doku (1,5 Zeilenabstand) + Anhang. Ich war größtenteils bei meiner Doku damit beschäfftigt, die auf die 10 Seiten einzukürzen. Mit anhang waren es dann 10 Seiten + 15 Seiten Anhang, Deckblatt und Inhaltsverzeichnis. Ist ja echt knapp bemessen bei euch.

[MBaeuml]

am besten immer auf den Webseiten der jeweiligen IHKs gucken, da gibt es so gut wie immer PDF Dateien wo beschrieben steht wie die Doku auszusehen hat (inhaltlich und formal).

Bei uns war es in der Tat so, 10 Seiten ohne Deckblatt und beliebig viel Anhang, wobei in den Anhang nur wirklich projektrelevante Sachen sollten, sonst Punktabzug.

2. Ja ich hab sie als PDF abgegeben, IHK Duisburg macht alles online, sprich am letzten Tag der Projektarbeit läd man das Ding hoch. Wen man es zu spät macht -> 0 Punkte. Dann muss man innerhalb von 2 oder 3 Tagen ein schriftliches Exemplar einreichen. Ja das wars.

3. Natürlich hab ich bei der Präsentation nicht die PDF Datei gezeigt und geklickt, die Doku hat der PA ja schon (einer hat die ganze Zeit während der Präsentation drin rumgeblättert) und stellt dann nachher zu bestimmten Sachen aus der Doku Fragen bzw. was entfernt zum Thema passt.

[pfc]

okidok, alles roger.

Meine zuständige IHK is die Wiesbadener.

Mann mann mann, da habe ich mich immer nur auf die Abschlussprüfung fixiert, kjaja bis november is lang hin, und dabei das Project + Doku + Präsentation fast schon ausser acht gelassen, MY FAULT...

Naja, da geh ich es jetzt mal besser an.

pfc

[MBaeuml]

okidok, alles roger.

Meine zuständige IHK is die Wiesbadener.

Mann mann mann, da habe ich mich immer nur auf die Abschlussprüfung fixiert, kjaja bis november is lang hin, und dabei das Project + Doku + Präsentation fast schon ausser acht gelassen, MY FAULT...

Naja, da geh ich es jetzt mal besser an.

pfc

Hehe es soll schon Leute gegeben haben die ihre Präsi in der Nacht vor dem Präsentationstermin fertiggestellt haben, in sofern hast du noch etwas Zeit

Kann nur sagen, Doku sofort!!! mit dem Projekt anfangen, dann weiß man alles und vergisst nix. Sollte ja sowieso projektbegleitend sein.

[IT2004]

Hehe es soll schon Leute gegeben haben die ihre Präsi in der Nacht vor dem Präsentationstermin fertiggestellt haben, in sofern hast du noch etwas Zeit

*lol* Ich hatte aufn IHK Parkplatz nochmal den Lappi hochgefahren und an einer Folie noch ne Kleinigkeit geändert.

[snerff]

Ich hab noch eine andere Frage zur Dokumentation:

Wie schreibt man den zeitlichen Ablauf auf? Muss ich das in der Art machen, dass ich immer Tag und Uhrzeit davorschreib und dann, was ich gemacht habe? Oder reicht es, wenn ich die Projektphase beschreibe und dann nachher "Verbrauchte Zeit: 2 Stunden" oder so dahinterschreibe?

Wie genau möchte der PA das sehen? Reicht es, wenn ich ans Ende meiner Doku eine Gegenüberstellung der geplanten und tatsächlichen Stundenzahl schreibe? Oder muss alles wirklich chronologisch festgehalten werden?

:confused: