Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Document Properties Marker
overridefalse
Short DescriptionA document should focus to answer one question. This way documents can be more easily reused and combined. 
Doctypepatternhide
NameSingle Responsibility Principle 
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
namesKnowledge Maintenance
propertyType

 
ValuesEasy to maintain, Easy to find, Easy to understand, Easy to use 
Iteration

Iteration
valuefinished

hide
Sort Keyhide
Section
show-titlefalse
titleDescription

If a piece of documentation covers many aspects of a concept, the document is harder to reuse.

Therefore a topic-based approach where each document covers explicitly only one aspect of a concept is typically preferred. This way authors can combine these pieces of information more easily to create their documents.

...

Section
required-permissionswrite-access
titleNotes

Section
titleReferences
intro-textMore information on this principle.
Tour
render-as-definition-listtrue
marker-column-property-nameTitle
replace-title-with-nametrue
TitleShort Description
Single Responsibility PrincipleThe principle described as a pattern on wiki.c2.com.
Single responsibility principleThe principle described on Wikipedia.
Section
titleResources