Learning patterns/Writing durable documentation

From Meta, a Wikimedia project coordination wiki
Jump to navigation Jump to search
Writing durable documentation
MechaDuck.png
problemin a sentence, please describe the problem this pattern addresses after 'problem='
solutionin a sentence, please summarize the solution this pattern provides after 'solution='
creatorHarej (WMF)
endorse
created on29 June, 2017
status:DRAFT


What problem does this solve?[edit]

Documentation allows you to preserve what you know and pass it to other people. You should write as much documentation as possible.

What is the solution?[edit]

  • Avoid template-heavy designs: they create a maintenance burden in the long term.
  • Consolidate around a few pages. Do not create three tiny pages when you can create one medium-sized page.
  • Don't make pages overly long. This contradicts the above but it is important to find balance.

Things to consider[edit]

When to use[edit]

See also[edit]

Related patterns[edit]

External links[edit]

References[edit]