Sinvolle Aufteilungen der Dokus?

[PodDog]

Hallo,

ich arbeite gerade an der Projektdoku.

Die Projektdoku für die IHK soll wenig technische Details beinhalten.

Daher wollte ich den technischen Teil in den Anhang bringen.

Jetzt habe ich aber ein Problem wie ich das am besten sinvoll Aufteile.

Ich habe das bisher so aufgeteilt;

- Anleitung für den User zum Verbinden eines Netzlaufwerks (WebDAV)

- Installationsanleitung (OS, Apache, WebDAV, Nagios, Backup und VPN)

- Handbuch für den Admin (Wie/Wo/Was er konfigurieren kann)

Ich überlege mir ob es nicht sinnvoller ist aus dem kleinem Handbuch für WebDAV nur ein Handzettel (2 DIN4-Seiten) zu machen. Und ein etwas größeres Installations und Konfigurations Handbuch (Kundenhandbuch) für den Admin?

Wisst ihr wie es der IHK lieber ist? Mehr Inhalt oder eher weniger Anhang.

Ich hoffe ihr könnt mir vielleicht ein Tipp geben.

Danke im Voraus.

[MartinSt]

Moin,

Die Projektdoku für die IHK soll wenig technische Details beinhalten.

Warum?

Die Projektdoku soll dein Projekt mit Planung, Durchführung und Resultaten darstellen; sie ist kein Handbuch, wie man mit dem entstandenen Produkt arbeitet oder es installiert.

Je nach Umfang und fachlicher Notwendigkeit können solche Anleitungen ggf. im Anhang dargestellt werden.

Gruß Martin

[pruefer_gg]

"Die" IHK hätte in der Projektdoku gerne beschrieben, was zum Projekt geführt hat - und wie der Weg vom IST-Zustand zur Realisierung war. Da spielt die Technik nur eine Rolle, wenn sie zum Verständnis des Projektes relevant ist.

Alles andere gehört in den Anhang - inkl. Kundendoku. Wobei Du hier schon entscheiden solltest, wer die Zielgruppe Deiner Kundendoku ist (Admins, User etc.?)

Der Umfang der Projektdoku und Anhang sind von der IHK abhängig (üblich sind 10 - 15 Seiten Klartext in der Doku - und 15 bis unbegrenzt viele Seiten für Anhang und Kundendoku).

Weitere Hinweise findest Du hier!

GG