Dokumentation / Projektbericht ?!?!

[Tini]

Hallo ihr!

Ich habe mir dieses grüne Buch vom WinklersVerlag bestellt, "Vorbereitung auf die Abschlussprüfung..." oder so ähnlich.

Mich hat dieses Buch in bezug auf die zu erstellende Doku sehr verwirrt.

In dem Buch wird zum einen die Doku, zum anderen der Projektbericht erwähnt.

Leider nicht sehr konkret, denn ich weiss jetzt überhauptnicht mehr was was ist- ich dachte bisher das wwären 2 versch. Namen für das gleiche Kind!

Naja, was mich ebenfalls wudnert, das in einem Beispielprojektantrag in diesem Buch, unter dem Punkt "Geplante Dokumentation", verschiedene Dokumente aufgeführt sind, die man dann später verwenden möchte, beispielsweise UMLs.

Bei unserer zuständigen IHK, wird es mit diesem Antrags-Punkt so gehandhabt, dass man hier eine komplette Gleiderung einträgt, die man dann so in etwa verwenden möchte + evtl. zusätzliche Dokumente.

Vielleicht könnt ihr mich aufklären, was ist die Doku, was der Projektbericht...

Was ist das 10-seitige Ding was wir anfertigen?

Tini

[TheLady01]

Es gibt da ein Prüfungshandbuch für IT'ler um genau zu sein:

"Prüfungsbuch für IT-Berufe" ist der Titel und

"Holland+Josenhans Verlag" der Verlag!

..... leider gibt es nur die Auflage von 2000......

...aber besser als nix!?

[TheLady01]

....SORRY, das Buch ist für die Schriftliche!

[Bubblegirl]

Hi!

Vielleicht ist mit der Doku die Kundendokumentation gemeint die du ja auch machen mußt.

Der Rest ist der Projektbericht in dem du deine Phasen durchgehst und diese dokumentierst mit den Ergebnissen die dir aus den Phasen bekannt geworden sind.

Das dürfte es eigentlich sein, so sieht das bei uns aus.

Gruss

Bubblegirl

[Tini]

achso...

und den projektbericht will am ende aber keiner sehen?

warum gibt es in dem schönen buch dann ein ganzes kapitel darüber??

tina

[Bubblegirl]

Hi!

Nee, da hast du was falsch verstanden der Projektbericht ist das was die meisten als Dokumentation verstehn. Und den mußt du auf jeden Fall abgeben ist schließlich dein Projekt.

Die Kundendokumententation ist ein Bestandteil deines Projekts und kommt in den Anhang muß also beides machen.

Gruss

Bubblegirl

[Tini]

Hallo du, danke für dein posting!

kannst du mir nochmal erklären was du als kundendoku bezeichnest, die in den anhang muss...

LG, Tini

[McCaffrey]

Hallo,

eine Kundendokumentation für FIAE wäre zum Beispiel eine Bedienungsanleitung für ein programmiertes Programm.

Mein Projekt als FISI war eine Site-to-Site Verschlüsselung. Meine Kundenunterlagen bestanden aus einer einfachen Überischt, wie sicher diese Verschlüsselung ist. Also genau dem, was den Kunden interessiert.

Deine Kundendokumentation sollte so aussehen, dass du dem Kunden, der normalerweise ja nicht fachlich versiert ist, diese in die Hand geben kannst, und er weiß was er zu tun hat, oder was du grob gemacht hast!

mfg

McCaffrey

[Tini]

Hallöchen!!

Und was ist nun, wenn ich das projekt nicht für einen kunden durchführe, sondern wenn es eine machbarkeitsstudie für eine abteilung ist?

LG, Tina

[McCaffrey]

Hi,

dann würde ich spontan sagen, dass du keine Kundenunterlagen erstellen musst!

Vielleicht könnt ihr mich aufklären, was ist die Doku, was der Projektbericht... Was ist das 10-seitige Ding was wir anfertigen?

Um kurz auf die Frage zu antworten: Das "10 Seitige Ding ist der Projektbericht! - Die Zahl der Seiten kann nach IHK variieren, deswegen findest du auch hier im Forum so unterschiedliche Angaben.

Zu diesem Projektbericht kommen ja noch Anlagen, wie z.B. Netzwerkpläne, oder eben auch UMLs. Das zusammen würde ICH dann als Dokumentation bezeichnen.

Im Projektantrag hatte ich als geplante Dokumentation angegeben:

a)Projektbericht

b)Zusätzliche Unterlagen zum Projektbericht:

b1) Netzplan

b2) Kundenunterlagen

usw.

So wurde mein Antrag dann auch genehmigt.

Hoffe ich hab deine Frage richtig verstanden!

mfg

McCaffrey

[bimei]

Original geschrieben von McCaffrey

dann würde ich spontan sagen, dass du keine Kundenunterlagen erstellen musst!

Es sei denn, man will dem Kunden (in diesem Fall Abteilung) das Ergebnis der Machbarkeitsstudie verständlich und anschaulich darstellen, das ist auch eine Kundendokumentation.

[Tini]

Naja, das sind alles Leute vom Fach...

Tini

[McCaffrey]

Dann könntest zu z.B. eine kleine Präsentation der Studie für eine Abteilungsrunde vorbereiten, und die Folien dann als Kundenunterlagen beilegen.

NICHT zu verwechseln mit der Abschlusspräsentation des Projekts. Die Präsentation meine ich nicht!!!

mfg

McCaffrey

[Tini]

Wird sowas wirklich verlangt?

Bei den IHK-arbeiten die ich gesehen habe, war so etwas nicht dabei...

warum soll ich eine Präsentation erfinden, die es nie geben wird.

Tina

[McCaffrey]

Nein,

wirklich verlangt wird es nicht. Wenn dein Projekt keine Kundendokumentation vorsieht, dann gibst du im Projektantrag auch keine an!

Es kann ja auch sein, dass du z.B. zeitlich gar nicht in der Lage bist, so etwas anzufertigen.

Von der IHK wird nur der Projektbericht mit den dazugehörigen Anlagen gefordert!

Ein Kundendokumentation selbst ist natürlich in der Hinsicht was feines, indem man einen schönen Abschluss seines PRojektes vorweisen kann.

Ich fänd es z.B. schön zu sagen: Das ist mein Programm, da hab ich meine Arbeit investiert, und hier ist das Ergebnis, das Benutzerhandbuch für den normalen Anwender. Ist aber eine persönliche Meinung

mfg

McCaffrey

[Tini]

Ja... So sehe ich das auch.

Ich habe im antrag nicht angegeben so eine Kundendoku zu amchen, er ist genehmigt, also amche ich auch keine.

Was denkst du könnten sinnvolle Anlagen sein.

Mein Thema:

Die Anwendung ClearCase der Firma rational auf einem Linux Red Hat Client funktionsfähig in die gegebene Netzwerkinfrastruktur zu stellen

Tini

[McCaffrey]

Original geschrieben von Tini

Ja... So sehe ich das auch.

Ich habe im antrag nicht angegeben so eine Kundendoku zu amchen, er ist genehmigt, also amche ich auch keine.

Was denkst du könnten sinnvolle Anlagen sein.

Mein Thema:

Die Anwendung ClearCase der Firma rational auf einem Linux Red Hat Client funktionsfähig in die gegebene Netzwerkinfrastruktur zu stellen

Tini

Ach so, ich dachte du hättest erst noch Prüfung und müßtest den Antrag usw. noch schreiben. Tschuldige!

Spontan würde ich z.B. einen Netzwerkplan der vorhanden Netzwerkinfrastruktur als Anlage vorbereiten.

Eine Installationsanweisung für die Anwendung ClearCase wäre ein weiterer Anhang

Ein Testprotokoll für den Funktionstest geht auch (Hab ich so gemacht )

mfg

McCaffrey

[Tini]

genau sowas hatte ich mir auch gedacht!

nur wie baut man so ein testprotokoll auf?

bei mir gibt es eigntlich nur "geht" oder "geht nicht", mehrere Tests liefern bei mir kein anderes ergebnis, sofern ich nicht einstellungen verändert habe im fall das es nicht geht.

es hat bei mir auf anhieb funktioniert. mein test ist also sehr knapp...

Tini

[Bubblegirl]

Hi!

Also ich weiß nicht wie eure IHK das macht, aber bei uns wird nach einem Bewertungsraster bewertet und da sieht ein Kundendoku vor. Und so weit ich weiß wird die auch mit 10-15 % gewertet.

Weiß ja nicht wie das bei euch abläuft ich hab jedenfalls eine gemacht und die kommt als Anlage zum Projektbericht.

Ich würde mich an deiner Stelle mal informieren ob so eine Kundendoku von nöten ist.

Und wenn es wirklich nur was simples ist, und nur weil man sie nicht hat 15 % Abzug zuhaben ist denke ich nicht so toll.

Meine Kundendoku sieht wie eine Bedingungsanleitung aus mit Screenshots und so.

Gruss

Bubblegirl

[McCaffrey]

Hi,

also bei der IHK Köln sieht das alte Bewertungsraster (2001)

für AE so aus:

Praxisbezogengene Dokumente und Unterlagen = 20%

Und dabei gibt es einen Punkt "Art der Unterlagen" der zwischen Betriebsdokumentation und Kundendokumentation unterscheidet, und ein paar Punkte aufführt, die dabei bewertet werden können.

Es ist aber nicht explizit eine Kundendokumentation gefordert!!

Abgesehen davon, Tini hat ja auch im genehmigten Projektantrag angegeben, keine Kundendokumentation zu erstellen. D.h. wenn sie nun doch eine Macht, muss sie dass auch noch begründen. Und eben zeitlich noch hinbekommen.

mfg

McCaffrey

[Bubblegirl]

Also in unserer Bewertungsmatrix steht als letzter Punkt Kundendoku und die wird mit 10-15 % gewertet, hab gerade nachgeschaut.

Für die Kundendoku mußte ich auch keine extra Phase in meinem Projektantrag machen, die Kundendoku gehört meiner Meinung ganz einfach zur Dokumentation deines Projekts genauso wie der Projektbericht.

Denn die Leute für die das Projekt ist können doch nicht nachvollziehen was du gemacht hast weil ud im Projektbericht eigentlich nur die Ergbnisse zusammen fasst.

Wie will den ein späterer Mitarbeiter der vielleicht mal deine Aufgabe übernehmen soll wissen wie du das durchgeführt hast?

Ich hab als Projekt Win2000 Advanced Server mit Web und FTP-Server.

Meine Kundendoku besteht aus einer Anleitung wie und was ich dort Konfiguriert habe.

Gruss

Bubblegirl

[McCaffrey]

Hi,

1)

wenn du eine Kundendokumentation machst, gehört sie zu deiner normalen Dokumentation, quasi als Anhang zum Projektbericht. Da geb ich dir vollkommen Recht!!!!!

Wenn in deiner Matrix steht, dass eine Kundendokumentation durchgeführt werden muss, dann mach auch eine. Alles andere wäre ja idiotisch.

Nur eine Kundendokumentation wird eben nicht für jedes Projekt und auch nicht von jeder IHK verlangt!

2)

Dein Beispiel mit der Übergabe des Projektes hinkt meiner Meinung nach ein wenig. Gegenbeispiel:

Wenn du ein Programm schreibst und es an einen Kollegen übergibst, damit er die Wartung usw. übernehmen kann, gibst du ihm dann das Benutzerhandbuch für den Kunden oder deinen Quellcode mit Erläuterungen ?

Hoffe du verstehst worauf ich hinauswill.

mfg

McCaffrey

[Bubblegirl]

Klar gibst du ihm den Quellcode!

Und dieser ist ja wahrscheinlich kommentiert?!

Also könnte man das in dem Fall als Kundendoku sehn.

Bei AE ist das ja noch mal was anderes als bei SI

Hehe, dann würde ich mal sagen hast du mehr Glück mit deiner IHK als wir und hast Zeit gespart weil du das Ding nicht machen mußt!

Gruss

Bubblegirl

[McCaffrey]

Also ich habs folgendermaßen gemacht:

Kundendokumentation (ich habe eine gemacht ) ist bei mir eine Übersicht für den Kunden, der IT-technisch nicht so versiert ist, was das Projekt für ihn bringt.

Intern hab ich genau wie du eine Installationsanweisung geschrieben, in der genau beschrieben wird, wie man die entsprechen Komponenten konfigurieren muss, mit Screenshots und allem.

Nur wenn ich das dem Kunden geben würde. Ich glaube er würde nur sagen: *äähhhhmmm, ja, also, schön..., gute Arbeit ... Ich muss weg*

Das Problem bei der Kundendokumetation ist eben, dass man genau drauf achten muss:

a) brauch ich eine?

wenn ja, für welchen Kunden?

c) was erwartet der Kunde?

Und das ist ja eben bei fast jedem Projekt verschieden. Es gibt also leider kein Kochrezept für eine Kundendokumentation

mfg

McCaffrey

[Bubblegirl]

Genau das ist das Problem.

Der Begriff Kundendoku ist ziemlich weitläufig und es kann fast alles als Kundendoku benutzt werde!

Muß halt jeder selbst wissen was er als Kundendoku nimmt.

Gruss

Bubblegirl