Kriterien zur Beurteilung der Dokumentation

Die Bewertung Ihrer Dokumentation berücksichtigt zusätzlich zur allgemeinen Qualitiät der Sprache folgende Elemente:

  • Allgemeine Einführung – konzeptuelle Erklärung der Anwendung, Verständlichkeit auch für Erstanwender.
  • Klare Sprache, möglichst wenig Fachausdrücke, bzw. deren Erklärung, falls verwendet.
  • Konsistenz der in der Dokumentation verwendeten Ausdrücke mit denen der grafischen Benutzeroberfläche.
  • Wenn möglich – Verwendung üblicher Ausdrücke, die der User von anderen Anwendungen kennt, vorzugsweise in seiner Sprache.
  • Index – Vollständigkeit, Relevanz, Links zu den relevanten Stellen der Dokumentation.