Kundendokumentation: Anrede, Vorgehensweise

[Duddle]

Hallo!

Im Moment plane ich meine Kundendokumentation und bin dabei auf ein triviales Problem gestossen: wie rede ich den Kunden an?

Wenn ich beispielsweise in der Doku über die Installation eines bestimmten Programmes schreibe:

a) Laden sie nun das Programm YYY von [ U.R.L. ] Agentur für Informationsdesign und bestätigen sie während des folgenden Installationsprozesses alle Schritte mit den Standardwerten.

Nun ist das Programm YYY von [ U.R.L. ] Agentur für Informationsdesign herunter zu laden. Bei dessen Installationsprozess müssen alle Schritte mit den Standardwerten bestätigt werden.

Variante a) oder ?

Ausserdem stutze ich noch etwas über die Vorgehensweise:

Soll die Kundendoku schlichtweg eine Art Handbuch sein? Also schreibe ich eine Installationsanleitung, eine Troubleshooting-Seite und einen Überblick über Passwörter und Dateirechte des Systems?

Oder wie muss ich mir das vorstellen?

Letztendlich muss das Ding ja zielgruppengerecht sein. Wenn derjenige aber ein ziemlicher Neuling ist mit dem, was ich im Projekt gemacht habe, dann muss ich das ja recht umfangreich beschreiben. Konkret geht es bei mir um Linux: Soll ich dann dem Kunden beschreiben, wie er vi bedient und eine Datei anlegt?

Danke im Voraus,

Duddle

[Chief Wiggum]

Nur zur Klarstellung: Mit der Kundendoku meinst du aber nicht die Projektdokumentation, sondern ein zusätzliches Dokument?

Allgemein gelten aber die Hinweise von Uli:

Prüfungs-FAQ

[Duddle]

Ja, ich meine zusätzlich zur Projektdokumentation ein Dokument. Ich zitiere mal aus dem Merkblatt der IHK Dresden:

10. Kundengerechte Dokumentation der Ergebnisse (Kundendokumentation als Anlage

mit max. 7 Seiten)

Duddle

[gouranga]

ich hohle den Thread mal wieder nahc Vorne, da ich dazu auch eine Frage habe. Ich bin auch an der IHK Dresden und gerade dabei die Projektdokumentation auf 10 Seiten zu bekommen (was ich sehr wenig Platz finde). Meine Frage: Was genau muss in die Kundendokumentation rein geschrieben werden?

[gouranga]

Und gleich noch eine Frage: Wenn ich einen Teil einer Projektarbeit, z.b. ein Script nicht selbst entworfen habe und es unter den Anlagen mit aufliste, muss ich dies extra kennzeichnen oder ist dies gar nicht erlaubt?

[btcMoses]

Hey, hau die Kundendoku doch einfach in den Anhang! Es ist ja eher ein extra Dokument, was eigentlich nix in der Doku zu suchen hat.

Frage 2: nicht selbst erstellte Dokumente müssen als solche gekennzeichnet werden und sind erlaubt (wenn sie nützlich sind)

[gouranga]

Hi, in den Anhang kommt die sowieso rein. Aber was genau soll in die Kundendokumenation. In meinem projekt sollte ich eine neue Software evaluieren und schließlich auf einem Server installieren + konfigurieren. Soll ich in die Kundendoku alle Einzelschritte der Installation + Konfiguration erläutern?

Und noch eine Frage, da ich eine Weiterbildung mache und mein Praktikumsunternehmen keinen Lohn zalht, wie soll ich da meine Kostenplanung für mich erstellen, kann ich mit 0,00 € Stundenlohn für mich rechnen?

[Deader]

Hi Leute,

also zur Kostenplannung kannst du nur reinnehmen:

Kosten für PC an dem du die Doku schreibst,Kosten für deinen Betreuer,Kosten der Software und Hardware, sowie sonstiges(Strom u.s.w.).Schicke dir dann mal ein Beispiel.

[gouranga]

Kosten für Betreuer?? Ich denke schon dass ich meine Kosten auch reinnehmen muss (obwohl die gleich 0 sind). ja schick dann mal bitte.

[gouranga]

Soll ich nun in die Kundendoku alle Einzelschritte der Installation + Konfiguration erläutern? Ich habe in meiner 10 Seiten Doku kein Platz um die detallierte Installation + Konfiguration zu beschreiben. Wenn ich diese aber in der extra Kundendokumentation beschreiben, fehlt sie mir in der Projektdoku. Kann ich Sie dort auch als Anhang beifügen?

[1pruefer]

Kosten für Betreuer?? Ich denke schon dass ich meine Kosten auch reinnehmen muss (obwohl die gleich 0 sind). ja schick dann mal bitte.

gouranga, die eigenen kosten sind eine gute idee. das würde ich wie üblich machen:

a std x stundensatz b = summe c

beim stundensatz 0,00 €/std kommt eben 0,00 € heraus.

dieses ergebnis ließe sich übrigens mit einem fiktiven bezahlten mitarbeiter vergleichen und so ein nutzen durch deinen einsatz als prüfling zeigen.

1pruefer