Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Document Properties Marker
overridefalse
Short DescriptionDocumentation 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. 
Doctypepatternhide
NamePrinciple of least Astonishment 
Short Name 
Parent
Parent Property
property-nameName
 
Audience
Name List
doctyperole
propertyAudience
 
Subject
Name List
doctypesubject
propertySubject
 
Categories
Name List
doctypecategory
propertyCategories
 
Tags
Tag List
propertyTags
 
Domain

Name List
doctypepattern-domain
namesSoftware Design
propertyDomain

 
Type

Name List
doctypepattern-type
propertyType

 
ValuesEasy to find, Easy to understand 
Iteration

Iteration
valuefinished

hide
Sort Keyhide
Section
show-titlefalse
titleDescription
Quote External
authorJ. H. Saltzer, Frans Kaashoek
sourcePrinciples of computer system design: an introduction
source-date2009

People are part of the system. The design should match the user's experience, expectations, and mental models.

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.

Section
titleExample

Section
titleContext

Section
titleProblem

Section
titleStructure

 

Section
titleAdvantages

Section
titleDisadvantages

Section
titleVariants

 

Section
titleSubordinate Patterns
Display Table
doctypepattern
render-no-hits-as-blanktrue
selectName, Short Description
restrict-to-immediate-childrentrue
sort-bySort Key, Name
Section
required-permissionswrite-access
titleNotes

Section
titleRelated Practices
intro-textThe following practices are related to this principle.

Display Table
doctypepattern
render-no-hits-as-blanktrue
render-modedefinition
where$<Principles>=[${Name}]

Section
titleRelated Principles
intro-textThe following principles are related to this principle.

Display Table
doctypepattern
render-no-hits-as-blanktrue
render-modedefinition
where$<Domain>=[${Domain}] AND Values:[* TO *]

Section
titleReferences
intro-textMore information on this principle.
Tour
render-as-definition-listtrue
marker-column-property-nameTitle
replace-title-with-nametrue
TitleShort Description
Principle Of Least AstonishmentThe principle described as a pattern on wiki.c2.com.

System Link
file/Principle_of_least_astonishment
system-idwikipedia-en
labelPrinciple of least astonishment

The principle described on Wikipedia.
Section
titleResources