oh-oh... [Seitenanzahl übersteigen - erlaubt?]

[unite]

..zunächst dachte ich es wird zu wenig, jetzt weiss ich gar nicht wie ich das alles auf 15 Seiten plazieren soll..

Weiss jemand ob man die von der IHK vorgegebene Seitenzahl übersteigen kann?

Ich muss Installationen von 3 unterschiedlichen Produkten durchführen, wobei eins davon Oracle 8.05 ist - wo soll ich den ganzen Installationsweg denn hinschreiben? - Ich meine mir reichen die 15 Seiten für die ganze Doku gar nicht mehr aus.

Hat jemand einen Rat für mich?

[f1h9ha]

Du kannst doch die Installationsschritte als ANhang Deklarieren !! ...

ANhängen kannst du so viel , wie du willst !! Wenn ich meine Source Code Doku mit in die Seitenzahl einrechnen müßte !! ohh ohh !! ..

... also .. irgendwie versuchen ... einen Anhang daraus zu machen ! oder Screenshots als Anhang falls du die im Text hast

So long , viel spass HACKTECK!

[Crush]

Das hängt von der IHK ab. Ein paar Seiten nehmen die bestimmt nicht zu ernst, aber ich weiß von einem Projekt, daß abgelehnt wurde, weil die Dokumentation zu umfangreich war. Die haben da erst gar nicht mehr reingeschaut. Es sollen mehrere hundert Seiten gewesen sein. Es ist empfehlenswert den Rahmen strikt einzuhalten. Ändere den Zeichensatz, nimm weniger Absätze, verkleinere wo es nur geht. Weniger Bilder, etc. auch am Satzbau kann man viel kürzen.

[Schaf]

Moing,

1 oder 2 Seiten drüber werden wohl kaum einen stören, aber übertreiben sollte man es auch nicht. Aber ich würde versuchen so viel wie möglich in den Anhang zu packen.

Ich kenne jemanden der hatte 20 Seiten Doku und 160 Seiten Anhang. Aber ich finde soviel Anhang braucht kein Mensch.

Schaf

[unite]

1. Zu viel Anhang ist auch nicht gut - Du kannst nach allem was darin steht gefragt werden - daher nur das reinpacken, was mach auch versteht - so ist meine Logik.

2. Eine weitere Frage hätte ich noch.

"Die Installationsschritte in den Anhang packen" - das ist eine gute Idee, nun wie soll es denn aussehen:

Bsp. A:

- Das Programm starten;

- Einstellungen vornehmen;

- etc.

und dann in der Doku schreiben, dass die Installation nach der Anweisung vorgenommen worden ist, die im Anhang beschrieben sind. (wobei die Installationsanleitung von mir selbst erstellt worden ist).

oder

Bsp. B:

im Anhang sofort schreiben:

- zunächst wurde mit dem Programm gestartet;

- desweiteren folgende Einstellungen vorgenommen

- etc.

Mir geht es um die Form selbst, was wäre richtig: Bsp. A oder Bsp. B? Oder ist es egal wie man es macht?

[Snowghost]

Die Installation von z.B. Oracle ist doch auch in den enstprechenden Handbüchern beschrieben. Also verweise doch einfach auf diese.

Bsp.: blablabla ... Die notwendigen Schritte für die Installation einer Oracle-DB konnten dem zugehörigen Handbuch (Quellenverweis xy) entnommen werden.

Snowghost

PS: Soviel Installationen? Bist du AE oder SI?

[unite]

ich bin FI-SI..

Wenn ich auf die Installationen auf die Installationshandbücher verweise, was soll ich dann in der Implementierung schreiben?

[Snowghost]

Darauf kann ich dir keien Antwort geben - kenne ja dein Thema nicht.....

Snowghost

[unite]

ich muss 3 Sachen installieren: Apache Server, Php-Modul einbinden, Oracle installieren, eine DB konfigurieren, ein betriebsinternes Programm installieren und die Verbindungen dazwischen schaffen.

Ich meine wenn ich jetzt die Apache Server Installation bereits beschrieben habe, und dann auf Oracleinstallation als Anhang verweise, dann steht ja zu Oracle nichts mehr im Teil: Implementierung drin? Worüber soll ich denn schreiben?

[Snowghost]

Ich würde vielleicht mehr auf die (nachträglich vorgenommene) Konfiguration eingehen. Die Installation der Module ist ja bereits in Büchern / HTML-Seiten etc. dokumentiert.

(Das ist jetzt aber nur meine persönliche Meinung....)

Snowghost

[unite]

Vielen Dank Snowghost !

hast mir richtig viel geholfen!!!

[Poldi]

übrigens, der schwerpunkt sollte auf dem prozeß, also dem weg dahin, und nicht dem wie liegen ... da muß gar nicht so sehr drinstehen, wie du das gemacht hast, sondern warum und wie.

... oh, und natürlich probleme, abweichungen vom zeitplan, etc pp

[Nini]

Also ich mache gerade so einen IHK Kurs mit für die Prüfungsvorbereitung, und uns hat der IHK- Mensch der auch im Prüfungsausschuss ist gesagt das es keine Regelung gibt wie groß eine Doku sein darf alles andere sei ein Mythos, aber die Doku sollte so um die 20-40 Seiten haben gut gegliedert ansprechend wenn möglich mit Grafiken, Anhang darf noch da sein wo alles rein gepackt wird was die Doku fett macht wir Source Code Rechner Konfiguration usw. Als Tipp hat er gemeint wir sollen uns in die Lage versetzten der Prüfer, in der Freizeit 50 Dokus durchlesen mit teilweise Überlänge und unübersichtlich.

Wie gesagt die 20-40 Seiten sind nur eine Empfehlung und Anhang ist eh wurst.

[unite]

Ich habe den Brief von der IHK Essen und da ist es strikt vorgegeben: 10-15 Seiten Doku.

[McCaffrey]

Hallo Jonatan,

in Köln dürfen wir sogar nur 10 Seiten mir 1,5 fachen Zeilenabstand schreiben.

Ich beziehe mich mal auf deine Oracle-Installation als Beispiel.

In der Dokumentation würde ich folgendes Schreiben:

Die Installtion von Oracle wurde mit der Installations CD-Rom (oder Netzwerk etc. ) erfolgreich durchgeführt.

Und dann weiter mit deinem Doku Text. Ich würde wahrscheinlich in dem Fall auch keinen Verweis auf den Anhang machen.

Nur im Inhaltsverzeichnis: Anhang A: Installationsbeschreibung Oracle

Wenn es den Prüfer dann interessiert, wie du Oracle installiert hast, kann er in den Anhang sehen.

Ich persönlich denke den Prüfer interessiert es nicht wo du jetzt auf "Weiter" klickst oder in welchem Verzeichnis du das Programm installierst.

Ihn interessiert, ob die Installtion erfolgreich war und womit du dann getestet hast und das Ergebnis der Tests.

mfg

McCaffrey

[unite]

vielen Dank für die Erklärung, bringt mich echt weiter!