You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 2
Next »
Documentation should appear to the reader as being written by one single person. Uniformity reduces the chance of astonishment. The principles applies to all areas of documentation, including style and organization.
People are part of the system. The design should match the user's experience, expectations, and mental models.
J. H. Saltzer, Frans Kaashoek. Principles of computer system design: an introduction. 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 they are looking for.
Readers expect a common structure for documents and the documentation. Diagrams and language should be similar throughout the documentation.
Consistency increases the predictability and reduce distraction. Systems following this principle are easier to learn.
References
More information on this principle.