Anwenderdoku Richlinien

[Troja2k 10]

Guten Morgen :)

 

In der Berufsschule machen wir gerade ein Projekt, wozu natürlich auch eine Anwenderdoku gehört.

 

Diese werde ich erstellen.

 

Nur wie??? :)

 

ich klappe schon die ganze zeit das internet nach einen grundgerüst o.ä. ab, aber hoffnungslos.

 

 

habt ihr tipps, wie man am besten dabei vorgeht? worauf ist zu achten? etc...

 

 

 

ein wenig hab ich schon gefunden

anwenderdoku.txt

[edv-olaf 10]

Hallo,

 

für eine technische Doku:

1.) Ist-Zustand

2.) Ziele / Soll-Zustand

3.a) Verschiedene Ansätze / Lösungswege / Pro+Contra

3.) geplante Vorgehensweise (Begründung) und Zeitplanung

4.) Pro Punkt der Vorgehensweise einen Hauptpunkt, der sich mit folgenden Unterpunkten beschäftigt:

a) Planung,

b) Umsetzung,

c) Ergebnisprüfung, (Soll / Ist)

d) Verbesserungen / Probleme der Machbarkeit / verbliebene Schwierigkeiten

n-1) [vorletzter Punkt] Gesamtbetrachtung, was hätte besser gemacht werden können, warum wurde es nicht so gemacht

n) [letzter Punkt] Ausblick

 

Anwenderdoku:

Hängt absolut vom Projekt ab (HW/SW/Programmierung/Installation)

Schreib einfach das rein, was du als DAU (dümmster anzunehmender User) nicht weisst, wenn du da ran gehst.

Was ist wo wieso wofür wann zu tun? Lass dir von jemandem helfen, der das Projekt nicht kennt. Schreib dir alle Fragen auf (auch die dummen, das sind die wichtigsten!). Beantworte alle Fragen mit der Doku. Nimm einen zweiten Dau und lass es gegenchecken.

Denk immer daran, der Leser weiss nix von dem, was du getan hast oder was er zur Bedienung tun müßte.

 

Und wenn du merkst, du musst für einen Sachverhalt mehr als 3 Sätze verwenden, dann nimm ein aussagekräftiges Bild mit in die Doku rein. --> Ein (gutes) Bild sagt mehr als 10.000 Worte.

 

Grüße

Olaf

[Adben 10]

Hi,

 

in Ergänzung zu Olaf seinem Post. Im Bereich Anwenderdoku ist noch die Frage, obs nur um einen Teil Aspekt geht oder um eine Doku einer Umgebung.

 

Will sagen sobald Du mehr als nur eine Installation oder ein Programm dokumentieren sollst, ist es wichtig die Doku zu unterteilen und in entsprechend aussagefähige Unterkapitel aufzuteilen.

 

Was die "dummen Fragen" anbelangt, vergiss nicht die Dinge zu beschreiben, die Du für selbstverständlich hälst. Generell gehen wir bei Dokus vom absoluten DAU aus.

 

Lars

[Troja2k 10]

Danke für eure Antworten :D

lasse heute abend meine mutter die mal lesen, sie hat null ahnung von pc's , also ist sie wohl die beste testperson *g*

 

habe zu jeden abschnitt der doku bilder bzw. screenshotseingefügt und nochmal ausführlich erklärt.

 

denke mal es ist ok im mom, aber noch längst nicht zufriedenstellend für mich *g*