Criteria for evaluating your documentation

When evaluating your documentation, I consider, over and above the general Quality of the language, the following criteria:

  • General introduction – conceptual explanation of the application, understandable also for the first-time user.
  • Clear and simple language, avoiding technical terms as far as possible, explaining them if used.
  • Whenever possible – use of generally known terms, in the users’ mother tongue.
  • Index – Relevance, links to the appropriate text in the documentation.