Einzelnen Beitrag anzeigen

Dezipaitor

Registriert seit: 14. Apr 2003
Ort: Stuttgart
1.701 Beiträge
 
Delphi 7 Professional
 
#9

AW: Passendes Konzept für eine Anwenderdokumentation

  Alt 11. Jul 2010, 23:34
Anwenderdokumentation entsteht aus der Spezifikation, u.a. den Anwendungsfällen.
Schau dir am Besten viele verschiedene Dokus, z.B. u.a. http://confiss.org (Mitwirkender)

Weiterhin muss man sagen, dass viele Handbücher garnicht gelesen werden. Manchmal ist es daher besser, (zusätzlich) eine Art Wissensdatenbank aufzubauen (oder FAQ) und zu propagieren, wo der Anwender gezielt suchen kann.
Weiterhin sollten Begriffe definiert werden (meist bereits in der Spezifikation gemacht), damit Anwender und Hersteller über dasselbe Thema reden.
Auch wichtig ist, dass der Schriftstil nicht zu kompliziert oder zu einfach gehalten wird, da dadurch die Anwender den Inhalt schlechter verstehen.
Und letztendlich ist es sehr wichtig, die Dokumentation auch am Anwender zu testen, um zu sehen, wo Nachbesserungsbedarf besteht.

Meine Liste ist nur eine Aufzählung und ist sicherlich nicht vollständig oder der Weisheit letzter Schluss.
Christian
Windows, Tokens, Access Control List, Dateisicherheit, Desktop, Vista Elevation?
Goto: JEDI API LIB & Windows Security Code Library (JWSCL)
  Mit Zitat antworten Zitat