Zielgruppe in die Doku???

[Gary]

Hallo zusammen...

ich habe meine Doku soweit fertig nun stellt sich mir allerdings die Frage ob ich in der Doku eine Zielgruppe mit angeben sollte.

Mein Projekt ist eine "Kommunikationsplattform für eine Programmierergruppe"...

Dieses Projekt wurde mir von meiner Firma gegeben... die Firma ist also der Kunde!

Erstelle ich jetzt die Doku eher für die Mitarbeiter meiner Firma... also die Leute die damit arbeiten müssen/bzw. meinen Auftraggeber oder erstelle ich sie ausschließlich für die Prüfer der IHK. Beim Benutzerhandbuch ist es ja klar, aber bei der Doku leuchtet mir das alles nicht so richtig ein!

Für die Mitarbeiter muss ja in der Doku nicht sooo perfekt bschrieben sein wie das Programm funktioniert. (also keine technische Doku)... Aber die Prüfer intressiert das doch bestimmt , oder etwa nicht?

Die wollen doch auch sehen das ich Ahnung davon habe... oder testen die das auschließlich im Fachgespräch???

Gruss

Gary

[timmi-bonn]

Original geschrieben von Gary

ich habe meine Doku soweit fertig nun stellt sich mir allerdings die Frage ob ich in der Doku eine Zielgruppe mit angeben sollte. [...] Erstelle ich jetzt die Doku eher für die Mitarbeiter meiner Firma... also die Leute die damit arbeiten müssen/bzw. meinen Auftraggeber oder erstelle ich sie ausschließlich für die Prüfer der IHK. Beim Benutzerhandbuch ist es ja klar, aber bei der Doku leuchtet mir das alles nicht so richtig ein! [...]

Das ist eine gute Frage, die hier immer wieder kontrovers diskutiert wird. Es gibt offensichtlich PAs, für die eine solche Doku an den PA gerichtet sein sollte. Andere PAs vertreten die Auffassung (ich übrigens auch), daß die Projekt-Doku für den Auftraggeber erstellt wird.

Allerdings hast Du völlig recht, wenn Du sagst, daß eine Doku kein Benutzerhandbuch ist. Die Doku beschreibt die Phasen des Projektablaufs. Der Leser (Zuhörer bei der Präsentation) soll sich dabei ein Bild vom Projektablauf machen können.

Wichtig ist dabei letztlich, daß Du eine Projekt-Doku ablieferst - und eben kein Benutzer-Handbuch.

gruß, timmi

[Gary]

Na dann ist es ja wuuuuunderbar!

Also denke ich mal das die Doku auch nicht allzu technisch sein sollte!

Ich erkläre zum Beispiel nur etwas oberflächlich was passiert "wenn man diesen Button drückt, dann öffnet sich..."! Ich gehe allerdings nicht präzise auf jede Zeile Quellcode ein. (also ich schreibe nicht wie eine Tabelle mit einer anderen verknüpft sein muss, damit dies und das funktioniert)....

Ach was rede ich ... in meiner Doku steht nicht eine Zeile Quellcode...

Immerhin schreibe ich eine Doku für meine Abteilung und nicht für irgendwelche Datenbankspezialisten oder Webdesigner.

Die Frage war ja eigentlich auch nur ob die IHK diesen Stil in der Doku akzeptieren wird.

Aber das muss sie einfach :D:D

Gruss

Gary

[Bako]

Original geschrieben von Gary

Die Frage war ja eigentlich auch nur ob die IHK diesen Stil in der Doku akzeptieren wird.

Aber das muss sie einfach

Aaalso,

1. Es gibt nicht die IHK, sondern bei jedem nur die zuständige IHK, jede IHK hat gewisse eigene Handlungsspielräume, insofern kann man so eine Frage nicht generell beantworten.

2. Deine IHK ist gar nicht der dafür zuständige Ansprechpartner, sondern der Prüfungsausschuss, denn die IHK ist nicht der Prüfungsausschuss und umgekehrt.

(um mal die Mißverständnisse aufzuklären )

Es kann vorkommen, dass einige Prüfungsausschüsse eine Zielgruppe vorgeben, dann sollte man sich daran halten. Um darauf eine Antwort zu bekommen, solltest Du Dich an Deine zuständigen PAs wenden. Sollte keine Vorgabe existieren, würde ich Doku und Präsentation für den Projektauftraggeber verfassen und ihn als Zielgruppe nehmen (wäre bei einem realen Projekt ja ebenso).