Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section
show-titlefalse
titleContent

To define the values of documentation for roles of stakeholders we need to find desirable qualities of documentation or team communication. The list of quality attributes to documentation is quite extensive and overwhelming.

Example Box

A sample of quality attributes for documentation:

Section
Column
  • accuracy
  • adequacy
  • authenticity
  • clarity
  • classifiability
  • clearness
  • completeness
  • conciseness
  • concreteness
  • confirmability
Column
  • consistency
  • correctness
  • editability
  • honesty
  • integrity
  • objectivity
  • organization
  • preciseness
  • readability
  • relevance
Column
  • retrievability
  • task orientation
  • timeliness
  • traceability
  • simplicity
  • style
  • understandability
  • usefulness
  • validity
  • visual effectiveness

To support teams seeking to create and maintain valuable documentation, we need to define a set of actionable qualities. Grouping is the first step to make qualities actionable. The second step is to make them more specific.

Section
titleSubordinate Topics
Display Table
doctypetopic
render-no-hits-as-blanktrue
selectName, Short Description
restrict-to-immediate-childrentrue
sort-bySort Key, Name

...