mirror of
https://github.com/johannesjo/super-productivity.git
synced 2026-07-18 17:05:48 +00:00
db5f927062
Substantial re-work and addition of meta notes. Still many stub notes and incomplete placeholders but the majority of the structure is established and filling out the actual content is now a priority.
1.3 KiB
Executable file
1.3 KiB
Executable file
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.