Fragen zur Projektdokumentation

[Letavino]

Guten Tag,

ich bin gerade dabei mein Projekt zu dokumentieren und habe dazu ein paar Fragen.

(Die Dokumentationen um Downloadbereich habe ich mir bereits angeschaut.)

Erst ein paar Informationen:

Ausbildungsberuf: FISI

Zuständige IHK: IHK Kassel

Abgabe des Projekts: November

1. Ich habe verschiedene Soft-/Hardwarevergleiche durchgeführt. Dieser Punkt ist sehr oft unter dem Überpunkt "Durchführung" zu finden.

Aber ist dies nicht eher ein Unterpunkt der Planung beim Erstellen des Soll-Konzepts?

2. Die Auflage der Seitenanzahl der Dokumentation beträgt 10 Seiten.

Ist es da sinnvoll den Punkt der Durchführung nur grob anzureißen und eine genaue Installationsanleitung in den Anhang zu packen?

Oder wird eine grobe Installationsanleitung, bei dem wichtigere Entscheidungen erklärt werden, lieber gesehen?

3. Die Zielgruppe sollte bei der Doku ein fachkundiger Prüfungsausschuss sein, soweit ich weiß.

Also ist es dabei nicht wichtig Fachbegriffe, die bekannt sein sollten, zu erläutern? Oder sollte man hier auf Nummer sicher gehen und alles, was Nicht-IT'lern unbekannt ist, kurz erklären?

Gruß, Letavino

[charmanta]

zu 1) Das kommt auf das Projekt an. Möglich ist beides.

zu 2) alles für das eigentliche Projekt irrelevante gehört in den Anhang. Eine Klickanleitung, grössere Bilder etc packt man auf jeden Fall stehts in den Anhang.

zu 3) Um sicher zu gehen schlüsselt man doch immer Fachbegriffe im einem Glossar auf, oder ?

[Letavino]

Vielen Dank für die Antwort!

zu 1) Das kommt auf das Projekt an. Möglich ist beides.

Ich habe es jetzt in die Planung gepackt. Nicht als Soll-Konzept, sondern als eigenen Punkt.

zu 2) alles für das eigentliche Projekt irrelevante gehört in den Anhang. Eine Klickanleitung, grössere Bilder etc packt man auf jeden Fall stehts in den Anhang.

Dann schickt eine sehr oberflächliche Erklärung der Durchführung in der Doku selber, also quasi eine reine Übersicht, mit einem Hinweis auf den Anhang, wo die Durchführung, evtl. sogar als "Klickanleitung", präzise hinterlegt ist?

Das würde sich bei dem wenigen Platz (10 Seiten), den man für die Dokumentation hat, gerade zu anbieten.

zu 3) Um sicher zu gehen schlüsselt man doch immer Fachbegriffe im einem Glossar auf, oder ?

Ja, das stimmt allerdings.

Ich hoffe, es ist trotzdem legitim, auch einige Begriffe in der Doku selber zu erklären, um den Lesefluss nicht zu sehr zu beeinträchtigen, oder?

Ach ja, eine Frage hätte ich doch noch:

Internetadressen im Quellenverzeichnis sind ja immer ein wenig kritisch zu sehen.

Wie genau muss man die Angabe einer Internetseite gestalten?

Beispiel: Schickt die Angabe von Wikipedia als Quelle, oder muss jede Unterseite einzeln angegeben werden?

[robotto7831a]

Bei einer Internetadresse schreibt man die URL und das Datum und die Uhrzeit wann man die Information dort gelesen hat.

Bei Wikis sollte man darauf achten, dass die URL ein permanenter Link ist und immer die Version zum Zeitpunkt des Abrufes wiedergibt.

Wikipedia ist wenn überhaupt nur eine Sekundärquelle. Unter vielen Artikeln stehen Verweise zu den Originalquellen und diese sollten verwendet werden.