Documentation

Usability Principle

This principle applies to the structure of this website as well as to its contents.

Understanding complexity

Almost everything can be understood if broken down into small parts and explained well enough.

In this spirit, this principle puts an emphasis on everything that improves understanding and objects to any unnecessary complication. Whatever helps in reducing the cognitive load is helpful.

Handling complexity

Knowledge has no value on its own. It has to be applied. This requires easy and quick access to the relevant knowledge whenever it is needed.

Since the world is complex, the main problem is not theoretical, but practical access to the knowledge.

For example, knowing that there is a good quote in a book is useless if one does not know the page and cannot find it.

For this reason, this website strives to make all its contents as easily accessible as possible, applying various available tricks and strategies, such as tags, searches, categories, cross-references, etc.

Further examples

  • Clear and simple language with a priority on understanding and correctness over style and eloquence.
  • Short sentences.
  • Clear structure.
  • Headings that explain the content of a paragraph.
  • Multiple examples for statements.
  • Illustrations and graphs.
  • Efficient structure.
  • Feature to search through content effectively.
  • Good documentation.
Table of contents