Fragen zur Doku - Inhalt und Design

[Cruel6]

Hallo liebe Fachinformatiker Community,

derzeit sitze ich an der Dokumentation für meine betriebliche Projektarbeit. Hierzu habe ich ein paar Fragen:

1. Muss ich angeben, wann ich welche Tätigkeit ausgeführt habe? Von wegen "Ich habe am xx.xx.2015 die Software xy installiert und am xx.xx.2015 die Software yx." (Das ganze natürlich als Projektphasenplan).. Aber ist das Pflicht bzw. sollte das rein? Eine Zeitplanung ohne Angabe der Tage an denen ich es durchgeführt habe ist bereits vorhanden. Ich habe während des Projektes auch andere Tätigkeiten durchgeführt also quasi nicht "durchgearbeitet".

2. Auf Seite X steht ganz unten die Überschrift mit zwei Zeilen Text. Auf der nächsten Seite steht der restliche Text. Sollte ich die Überschrift auf die nächste Seite verfrachten, damit alles auf einer Seite ist?

3. Genau andersrum wie bei 2. - Auf Seite X Steht ein Text und auf der nächsten Seite 1 Zeile die zu diesem Text gehört. Sollte ich versuchen, den Text noch auf die selbe Seite zu bekommen, oder ist das egal?

4. Ist es schlimm, wenn die Zeitplanung ein anderes Design hat, als im Projektantrag? Ich habe das Design in der Doku einheitlich gemacht. (Alle Tabellen gleich gestaltet)

5. Ich habe am Anfang des Projektes ein Lösungskonzept entwickelt. Da dieses die Situation vor der Durchführung beschreibt, ist das Konzept in der Futur Zeitform geschrieben. Ist das in Ordnung, oder sollte ich dies lieber im Präteritum schreiben, wie den Rest der Dokumentation? Meiner Meinung nach sollte es im Futur bleiben.. Falls es die IHKs so normalerweise nicht wollen, ändere ich es aber ab.

6. Muss ich einen Nachweis führen, dass ich das Projekt wirklich in 35 Stunden und dem angegebenen Zeitraum erledigt habe? Falls ja, wie? Ich habe mit der Zeit nicht geschummelt, also wäre es prinzipiell kein Problem.

7. Hinterfragt es die IHK, wenn ich die Dokumentation erst 2 Wochen nach der angegebenen Beendigung des Projektes hochlade und abgebe? Eigentlich würde ich die Doku gerne anschließend noch etwas behalten, um eventuelle kleine Verbesserungen durchzuführen.

8. Mein Anhang ist im Großteil wie folgt aufgebaut "Screenshot + Beschreibung, Screenshot + Beschreibung, usw.." ist das so in Ordnung? Gibt es etwas, das ich beim Design beachten sollte? Die Beschreibung steht stets unter dem Screenshot und niemals daneben. Daneben schreiben würde Platz sparen, aber die leichte Übersichtlichkeit geht dann meiner Meinung nach verloren.

So das wärs fürs erste.

Vielen Dank schonmal vorab!

Bearbeitet 10. April 2015 von Cruel6

[arlegermi]

1) Muss nicht sein. Solange der zeitliche Ablauf nachvollziehbar ist, ist alles ok.

2) + 3) Das wirkt sehr stümperhaft, also wenn's irgendwie geht, vermeiden.

4) Dass die Doku anders aussieht als der Projektantrag dürfte bei (fast) jedem der Fall sein.

5) Wenn das Lösungskonzept vernünftig formuliert ist, ist Futur grundsätzlich ok.

6) Bei der IHK nachfragen.

7) Dass die Doku erst einige Zeit nach dem Projekt selber fertig wird, ist völlig normal und ok.

8) Für Screenshots ist der Aufbau ok. Hast du außer Screenshots nichts, was du in den Anhang packen kannst?

[Cruel6]

Erstmal vielen Dank für die Antwort!

Zu 2) Also z.B. lieber 5 Leerzeilen am Ende der Seite, als das oben beschriebene?

Zu 8) Damit meinte ich nur den Großteil des Anhangs, indem ich einzelne technische Abläufe beschrieben habe. Ansonsten befinden sich da auch noch ein Angebot, Tabellen, ein Administrationshandbuch und und und.. Mir ging es da hauptsächlich um eben diesen Teil den ich mit Screenshots befüllt habe.

[Asura]

Hallo liebe Fachinformatiker Community,

derzeit sitze ich an der Dokumentation für meine betriebliche Projektarbeit. Hierzu habe ich ein paar Fragen:

1. Muss ich angeben, wann ich welche Tätigkeit ausgeführt habe? Von wegen "Ich habe am xx.xx.2015 die Software xy installiert und am xx.xx.2015 die Software yx." (Das ganze natürlich als Projektphasenplan).. Aber ist das Pflicht bzw. sollte das rein? Eine Zeitplanung ohne Angabe der Tage an denen ich es durchgeführt habe ist bereits vorhanden. Ich habe während des Projektes auch andere Tätigkeiten durchgeführt also quasi nicht "durchgearbeitet".

2. Auf Seite X steht ganz unten die Überschrift mit zwei Zeilen Text. Auf der nächsten Seite steht der restliche Text. Sollte ich die Überschrift auf die nächste Seite verfrachten, damit alles auf einer Seite ist?

3. Genau andersrum wie bei 2. - Auf Seite X Steht ein Text und auf der nächsten Seite 1 Zeile die zu diesem Text gehört. Sollte ich versuchen, den Text noch auf die selbe Seite zu bekommen, oder ist das egal?

4. Ist es schlimm, wenn die Zeitplanung ein anderes Design hat, als im Projektantrag? Ich habe das Design in der Doku einheitlich gemacht. (Alle Tabellen gleich gestaltet)

5. Ich habe am Anfang des Projektes ein Lösungskonzept entwickelt. Da dieses die Situation vor der Durchführung beschreibt, ist das Konzept in der Futur Zeitform geschrieben. Ist das in Ordnung, oder sollte ich dies lieber im Präteritum schreiben, wie den Rest der Dokumentation? Meiner Meinung nach sollte es im Futur bleiben.. Falls es die IHKs so normalerweise nicht wollen, ändere ich es aber ab.

6. Muss ich einen Nachweis führen, dass ich das Projekt wirklich in 35 Stunden und dem angegebenen Zeitraum erledigt habe? Falls ja, wie? Ich habe mit der Zeit nicht geschummelt, also wäre es prinzipiell kein Problem.

7. Hinterfragt es die IHK, wenn ich die Dokumentation erst 2 Wochen nach der angegebenen Beendigung des Projektes hochlade und abgebe? Eigentlich würde ich die Doku gerne anschließend noch etwas behalten, um eventuelle kleine Verbesserungen durchzuführen.

8. Mein Anhang ist im Großteil wie folgt aufgebaut "Screenshot + Beschreibung, Screenshot + Beschreibung, usw.." ist das so in Ordnung? Gibt es etwas, das ich beim Design beachten sollte? Die Beschreibung steht stets unter dem Screenshot und niemals daneben. Daneben schreiben würde Platz sparen, aber die leichte Übersichtlichkeit geht dann meiner Meinung nach verloren.

So das wärs fürs erste.

Vielen Dank schonmal vorab!

Zu 1: Muss nicht sein, es reicht die Nachvollziehbarkeit der Schritte. Eine Zeitplanung wie "Am Tag eins um 10:10 habe ich die Installation von ... gestartet" ist nicht erforderlich oder gewünscht. Du hast bereits eine Zeitplanung abgegeben, du kannst darauf in der Ist/Soll-Analyse mehr eingehen.

Zu 2/3: Solltest du vermeiden. "Einfach" 1-2 Sätze im Text darüber schreiben, damit die Seite gar ausgefüllt ist und nicht all zu viel Platz noch vorhanden ist.

Zu 4: Ich weiß nicht wie es bei eurem Antrag war, in meinem Antrag habe ich jedenfalls einfach formatiert.

1. Planung: 7 Stunden

- Ist-Zustand: 2

- Kundengespräch:2

- ...

In meiner Doku jedenfalls werde ich es natürlich anhand einer Tabelle formatieren.

5. Grundsätzlich, würde ich alles in der Gegenwartsform schreiben, solange es in der Gegenwart aktiv ist. Beispielsweise Lösungswege, wohingegen Kostenplanungen und Realisierungen in einer Vergangenheitsform geschrieben werden. ( Angaben ohne Gewähr, mein Empfinden)

6. 35 Stunden sind geplant. Mit einem Satz "Das Projekt wurde erfolgreich in der vorgegeben Zeit von 35 Stunden erfüllt." würde ich es abschließen, ich würde das aber auch hinschreiben wenn ich mehr gebraucht habe. - In meinem Fall, wurde ich aber auch in 35h auch fertig. -

7. Die IHK interessiert es nicht wann du dein Projekt machst. Sie interessiert nur die 35 Stunden und dass die Dokumentation bis zum Enddatum abgegeben ist. Und nach der Genehmigung deines Antrages stattfindet.

8. Bilder mit Beschreibung ist in Ordnung, ich würde sagen, solange bis du ein Bild nicht umbedingt mit einer viertel Seite Beschreibst. Notfalls schreibst du noch "Aus Gründen der Übersichtlichkeit, steht die Beschreibung der Screenshots unter den Bildern"

Ich hoffe ich konnte ein wenig helfen.

Angaben sind ohne Gewähr und entsprechen keiner Musterlösung.

Bearbeitet 10. April 2015 von AsuraDeYien