"Geplante Dokumentationen" - WAS gemeint, dringend!

[Neo van Matix]

Hallo,

die Zeit eilt bei mir grad etwas. Hab gerade mit Kollegen über meinen Projektantrag geredet, den ich morgen abgeben wollte.

Ich habe den Punkt "Geplante Dokumentationen zur Projektarbeit" so verstanden, dass ich dort zusätzliche Doku's aufzähle. Mein Projekt handelt im groben von Nagios - somit hätte ich dort aufgeführt "Installation von Testserver".

Das scheint aber nicht richtig zu sein. Nun bin ich ziemlich überfragt, WAS genau ich dort rein bringe? Die Groben Abschnitte für die Doku sind ja eigentlich schon aus meinem Projektplan ersichtlich:

Projektvorfeld  

- Zieldefinition und Evaluierung der Infrastruktur (Ist-Analyse)                         1,5

- Marktanalyse von Monitoring-Lösungen                                                         2,5

- Definition und Konzeption des Lösungsansatzes (Soll-Analyse)                    1,0


Produktphase  

- Evaluierung von Hardwareanforderungen                                                       1,0

- Auswahl eines geeigneten Betriebssystemes                                                 0,5


Realisierungsphase  

- Installation/Konfiguration eines Dienste-Servers für Testphase                      2,0

- Vorbereiten der Hardware (Anpassungen an Anforderungen)                        1,0

- Installation des Betriebssystemes                                                                   1,0

- Installation der ausgewählten Monitoringlösung                                             1,0

- Konfiguration                                                                                                 10,0


Testphase  

- Test der Monitoring-Lösung in separatem Netz anhand des Testservers      3,5


Ausarbeitung der Projektdokumentation                                                         10,0

------------------------------------------------------------------------------------------------------------

Summe:                                                                                                           35,0

WAS genau ist damit gemeint?! Bitte ein Beispiel!

[hangy]

So wie ich das hier im Forum gesehen habe, scheinen die meisten Leute dort das einzutragen, was bei der Dokumentation im Endeffekt ungefähr dem Inhaltsverzeichnis entsprechen würde, sprich Aufbau der Dokumentation ...

[Neo van Matix]

Muss ich das detailliert angeben...? Oder genügt etwas "grobes"? Ich weiß ja jetzt noch nicht, welche genauen Punkte sich ggf. noch im Laufe es Projekts ergeben, ich habe ja noch nicht damit begonnen :/

Sowas wie:

- Marktanalyse Monitoring-Software

- Installation und Konfiguration der Monitoringlösung

- Konfiguration der regelmäßigen Überprüfungen

- Test der Anwendung

?

[disarstar]

Also mein Antrag ging problemlos durch. Hatte mich einfach an die Vorgaben gehalten. Bei Dokumentation solltest du noch splitten.

Dokumentation IHK x std.

Kundendokumentation x std.

Die IHK erwart eine Kundendoku im Anhang. Da es bei mir keinen "Kunden" gab hatte ich stattdessen ein Administratives Handbuch für den Inhouse-Support.

Schau dir einfach mal die Handreichungen der IHK an. Weiss nicht ob die Bundesweit gleich sind. Aber hier ist der Link:

http://www.dortmund.ihk24.de/produktmarken/bildung/anlagen/IT_Handreichungen.pdf

3. Projektantrag und Genehmigungsverfahren

7

Die Ausbildungsordnungen sehen vor, dass der Prüfungsteilnehmer in Teil A der

Prüfung in insgesamt höchstens 35 Stunden (70 Stunden beim Fachinformatiker/

Anwendungsentwicklung) eine betriebliche Projektarbeit durchführen und dokumentieren

sowie in insgesamt höchsten 30 Minuten die Projektarbeit präsentieren und

darüber ein Fachgespräch führen soll.

Diese betriebliche Projektarbeit stellt keine „künstliche“, also ausschließlich für die

Prüfung entwickelte Aufgabenstellung dar, sondern ist „echt“ und basiert in der Thematik

auf dem betrieblichen Einsatzgebiet. Dabei kann die Projektarbeit ein eigenständiges,

in sich abgeschlossenes Projekt ober auch ein Teilprojekt aus einem größeren

Zusammenhang sein. Der Ausbildungsbetrieb muss sicherstellen – und dies

ist im Projektantrag mittels PIN-Code auch zu bestätigen –, dass von der Projektarbeit

keine schutzwürdigen Betriebs- oder Kundendaten betroffen sind.

Der formalisierte Projektantrag enthält zunächst die Daten des Prüfungsteilnehmers

sowie Ausbildungsberuf und Einsatzgebiet, Angaben zum Ausbildungsbetrieb und

zum betrieblichen Betreuer als mögliche Kontaktperson für den Prüfungsausschuss,

die Projektbezeichnung oder das Thema der Projektarbeit sowie den Durchführungszeitraum.

Darüber hinaus ist das Einverständnis des Ausbildungsbetriebes zur

Durchführung des Projektes einzuholen. Der Projektantrag wird vom Antragsteller/

Auszubildenden sowie vom Ausbildungsbetrieb mittels PIN-Code bestätigt.

Von besonderer Wichtigkeit ist im Rahmen des Projektantrages die Projektbeschreibung.

Darunter ist die Erläuterung des Geschäftsprozesses bzw. die Darstellung des

praktischen Problems zu verstehen. Weiterhin sind in kurzer und knapper Form die

Einbindung und die Schnittstellen des Projektes innerhalb eines Auftrages bzw. Teilauftrages

darzustellen.

Auch sind Angaben zum Ist-Zustand, z. B. der technischen Einrichtung für den ITSystem-

Elektroniker anzugeben. Außerdem werden Hinweise zur Nutzendarstellung

für den Kunden bzw. zum Ziel des Auftrages erwartet.

Ferner sind die Projektphasen einschließlich eines Zeitplanes anzugeben. Dazu gehören

die Definition der Kernaufgaben des Projektes, eine Kennzeichnung der davon

8

prüfungsrelevanten Aufgaben, die Zuordnung dieser Aufgaben zu Zeitumfängen, die

Darstellung zeitlicher Abhängigkeiten innerhalb des Projektes und ein konkreter

Terminplan. Darüber hinaus ist anzugeben, wie die Dokumentation voraussichtlich

gestaltet wird. Unbedingt erforderlich ist ein prozessorientierter Projektbericht, der

später genau erläutert wird. Erwartet werden ebenfalls kurze Angaben zu praxisüblichen

Unterlagen bzw. zur Kundendokumentation, die der Dokumentation als Anlage

beigefügt werden.

[Neo van Matix]

Ohje, wie gestalte ich das den nun?

"Kundendokumentation" habe ich ja in dem Fall auch nicht. Und ein Administratives Handbuch - wie z.b. mit Nagios umgegangen werden soll - erübrigt sich auch, dass sollte eigentlich Kern meines Projektes sein (Ich nehme mir Server X mit Diensten Y, und erstelle für entsprechende Dienste Servicechecks).

:/

[disarstar]

Ich denke das erübrigt sich nicht. Es kommt zwar in den Anhang aber gehört zu deiner Planung. Der Umfang ist ja dafür nicht definiert.

Musst dir einfach 2 Fälle vorstellen:

Du arbeitest mit 5 anderen Admins im Betrieb. Wird ein neues System installiert (z.B. Nagios) sollte ne kleine Doku vorliegen fürs Handling und der aktuellen Konfiguration.

Du erfüllst im Auftrag eines Kunden ein Projekt. Ihn wird wohl kaum sone IHK Doku interessieren. Er will eine Kundendoku mit Einführung/Handling und Troubleshoot bzw. Ansprechpartner im Supportfall.

Find deinen Antrag soweit ok. Meiner Meinung nach solltest du allerdings bei der Dokumentation splitten in IHK(8std) und Admindoku (2std).

Und versuch nicht so große Zeitblöcke zu setzen wie 10std Konfiguration. Teil es hier auch realistisch ein in Kleinere Blöcke.

Konfiguration Betriebssytem

Konfiguration Nagios

...

Bearbeitet 12. Januar 2009 von disarstar

[Forcid]

Denke mal für Nagios selbst gibts auch ein Handbuch, das kannst du dort ja mitaufführen und zusammen mit der Doku abgeben. Bei mir konnt ichs auch auf CD/DVD usw abgeben. So musst du nicht etliche Seite extra ausdrucken.

Und nun ohje mal weniger, so schlimm ist das nu auch wieder nicht

[disarstar]

Sag ja der Umfang ist da nicht definiert.

Es würde ja für einen anderen Admin ausreichen auf einen Blick zu sehen wie das Nagios konfiguriert wurde.

Und einen Verweis auf das Nagios Handbuch zu geben.

P.S. Ich kann hier nur das wiedergeben was mir von meinen Projektbegleiter von meinem Bildungsträger vermittelt wurde der im Jahr bestimmt 200 Projektanträge begleitet. Er bemängelte anfangs bei mir zu große Zeitblöcke und auf die Kundendoku wurden wir direkt hingewiesen.

Bearbeitet 12. Januar 2009 von disarstar

[Forcid]

Sag ja der Umfang ist da nicht definiert.

Es würde ja für einen anderen Admin ausreichen auf einen Blick zu sehen wie das Nagios konfiguriert wurde.

Und einen Verweis auf das Nagios Handbuch zu geben.

P.S. Ich kann hier nur das wiedergeben was mir von meinen Projektbegleiter von meinem Bildungsträger vermittelt wurde der im Jahr bestimmt 200 Projektanträge begleitet. Er bemängelte anfangs bei mir zu große Zeitblöcke und auf die Kundendoku wurden wir direkt hingewiesen.

So einen Hinweis gabs bei uns nicht. Ich hab auch "nur" die Doku für die IHK und ein Handbuch zu der Software, die ich verwendet habe, abgegeben.

[Neo van Matix]

Gibt es ein Limit für diese Anhänge? Ich habe mal was gehört, dass zusätzliche Dokumentation nicht mehr als 25 Seiten sein darf - oder so.

Und,... gehört zu diesem "geplante Dokumentation" auch ein originelles Handbuch, z.b. von Nagios? Weil, ich plane ja nicht die Dokumentation zu schreiben, die Doku wäre nur ein "Zusatz".

[GuntiNDDS]

Nach meinem Kentnissstand gibt es keine Vorschrift über die maximale Anzahl, bzw. die Länger der Anhänge. Lediglich die Dokumentation ansich ist begrenzt.

Zumindest wurde mir das bisher von mehreren Personen so geschildert.

Was stellst du dir denn unter "originelles Handbuch" vor ?

Vllt. ein Handbuch in Fabel- oder Gedichtform :D

Bearbeitet 12. Januar 2009 von GuntiNDDS

[Forcid]

Frag da am Besten mal bei dern IHK nach. Hab ich auch gemacht. Und ansonsten bleibt dir ja die Möglichkeit der CD, wenns zuviel ist.

[hangy]

Nach meinem Kentnissstand gibt es keine Vorschrift über die maximale Anzahl, bzw. die Länger der Anhänge. Lediglich die Dokumentation ansich ist begrenzt.

Das ist vermutlich wieder von IHK zu IHK unterschiedlich, sodass eine allgemeine Aussage nur schwer zu treffen ist. Allerdings halte ich es unwahrscheinlich, dass die zulassen, dass jemand ein hundertseitiges Handbuch eines Produkts das für die Umsetzung relevant war anhängt.

In der Handreichung der IHK Nord Westfalen steht übrigens:

[…] Die Seitenzahl der Anhänge soll insgesamt 30 Seiten nicht überschreiten. […]

Aber wie gesagt: Das ist nicht allgemeingültig, also im Zweifel bei der eigenen IHK nachfragen!

Und ansonsten bleibt dir ja die Möglichkeit der CD, wenns zuviel ist.

Ich glaube nicht, dass die eine CD als Anhang akzeptieren ... da müsste man schon eine sehr gute Begründung liefern.

Bearbeitet 13. Januar 2009 von hangy
Edit vermeidet Doppelpost.