Back to Super Productivity

Wiki Documentation Framework

docs/wiki/0.-Meta-Diataxis.md

18.4.41.3 KB
Original Source

Wiki Documentation Framework

This Wiki is structured based on the Diátaxis framework for documentation. A more practical description of how to implement it is found at Openedx.

The Diataxis framework is an approach to quality in technical documentation and creates a systematic organization. Diataxis identifies four modes of documentation:

  • Quickstart: teach you how to do something
  • How-To Guide: tell you what to do to solve a problem or complete a task
  • Reference: factual, static information
  • Concepts: explain the theory, context, purpose, and/or utility of something

See [[0.00-Wiki-Structure-and-Organization]] for more details on how this framework is implemented so far.