Date: Fri, 29 Mar 2024 12:54:27 +0100 (CET) Message-ID: <1065978518.17944.1711713267120@09e9d69a2016> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_17943_998151569.1711713267119" ------=_Part_17943_998151569.1711713267119 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
Documentation should appe= ar to the reader as being written by one single person. Uniformity reduces = the chance of astonishment. The principles applies to all areas of document= ation, including style and organization.
A program should follow the `Law of L= east Astonishment'. What is this law? It is simply that the program should = always respond to the user in the way that astonishes him least.
= Geoffrey James. The Tao of Programming. 1987
People are part of the system. The= design should match the user's experience, expectations, and m= ental models.
J. H. S= altzer, Frans Kaashoek. Principles of computer system design: an introducti= on. 2009
Same things should be handled the same. Similar things should be handled= similar. This way readers have an easier job to locate the information the= y are looking for.
Readers expect a common structure for documents and the documentation. D= iagrams and language should be similar throughout the documentation.
Consistency increases the predictability and reduce distraction. Systems= following this principle are easier to learn.
The following practices are related to this principle.
The following principles are related to this principle.
More information on this principle.