Checkliste zur Anwenderdokumentation

Inhalt
Vollständigkeit
Einheitlichkeit
Verständlichkeit
Einhaltung des Standards
Sonstiges

Vollständigkeit

1. Sind alle Funktionen des Softwareproduktes im Anwenderhandbuch beschrieben?

2. Ist die Bedienung jeder Funktion vollständig und eindeutig dokumentiert?

3. Ist ein Inhaltsverzeichnis vorhanden?

4. Wird deutlich, wie die fachlichen Verarbeitungsschritte im Programm umgesetzt werden?

5. Ist die Tastenbelegung aller Funktionen beschrieben und stimmt die Beschreibung mit dem Programm überein?

6. Enthält die Dokumentation ein Verzeichnis der Fehlermeldungen mit Erläuterungen?

Einheitlichkeit

7. Sind Bezeichnungen und Funktionsbeschreibungen einheitlich?

8. Werden im Programm und in der Dokumentation identische Begriffe für den gleichen Sachverhalt verwendet?

9. Ist die Dokumentation einheitlich strukturiert, ist sie systematisch durchnumeriert?

10. Werden Seitennummern, Überschriften, Kopf- und Fußzeilen immer einheitlich angegeben?

11. Entsprechen die Abbildungen von Masken im Anwenderhandbuch den Masken im Programm?

Verständlichkeit

12. Ist die Dokumentation sprachlich und inhaltlich verständlich?

13. Sind die Beispiele im Anwenderhandbuch am Produkt nachvollziehbar?

14. Werden komplexe Abläufe durch Grafiken veranschaulicht?

15. Sind die Referenzen korrekt?

16. Stimmt die Dokumentation mit dem Programm und das Programm mit der Dokumentation überein?

17. Ist es einfach, die Beschreibung eines bestimmten Problems in der Dokumentation zu finden?

Einhaltung des Standards

18. Enthält die Anwenderdokumentation mindestens folgende Teile:

19. Entspricht die formale Gliederung der einzelnen Fächer des Anwenderhandbuchs der Beschreibung im Standard?

20. Sind die wichtigsten Bildschirmmasken mindestens einmal im Handbuch abgebildet?

21. Gibt es einen Abschnitt, in dem Probleme bei der Bedienung behandelt werden, zu denen keine Fehlermeldung angezeigt wird?

22. Entsprechen der Aufbau des Ordners, der Satzspiegel und die Ergänzungslieferungen dem Standardvorschlag?

23. Entsprechen die Spezifikationen der Programmkarte - falls vorhanden - dem Standardvorschlag?

24. Beschreibt die Kurzanleitung - falls vorhanden -die wesentlichen Programmfunktionen (z.B. im Hilfesystem)?

25. Entspricht die Eingliederung der Informationen zur Netzversion ins Handbuch der Beschreibung im Standard?

26. Sind die Absätze am Rand mit dem Netzwerksinnbild markiert?

27. Entspricht die Gliederung der netzwerkspezifischen Funktionen in Kapitel und Unterkapitel der Beschreibung im Standard?

28. Enthält die Leistungsbeschreibung (als eigenständiger Artikel oder im Handbuch integriert) die Standard-Gliederungspunkte in der angegebenen Reihenfolge?

29. Werden in der Leistungsbeschreibung die Standardtexte verwendet?

30. Ist die Leistungsbeschreibung im Fach ANHANG - falls vorhanden - eingeordnet?

31. Entspricht der Satzspiegel der Leistungsbeschreibung dem der Handbücher?

32. Entspricht der Inhalt des Beipackzettels und der Readme-Datei dem Standard?

33. Werden im Beipackzettel und in der Readme-Datei die Standard-Texte verwendet?

34. Entspricht das Layout des Beipackzettels und der Readme-Datei dem Standard (vgl. Musterseiten)?

Sonstiges

35. Gibt es Mängel in der Dokumentation, die nicht mit der Beantwortung obiger Fragen erkannt wurden?