Documentation

September 12, 2021

Divio Unified Theory of Documentation #

Reference

Documentation can be divided into 4 clear buckets, each of which serves a distinct purpose.

Tutorials #

• Its a cooking lesson, like teaching a child to cook. What you cook isn’t important, its getting them familiar with the process, getting them to enjoy it and want to doi t again.
• Using software, like cooking is a matter of craft - we learn by doing

How to guide #

• Its like a recipe and assumes you already know basic cooking techniques and is helping you resolve a need

Reference #

• Its like a encylopedia entry about a single ingredient - ginger. Covering any and everything like provenance, chemical make up, origin, its uses.
• All information is presented in similar ways.

Explanation #

• Its like a work (eg book, show) that discusses food, cooking in the context of history & culture, science of cooking and technology.
• Its not meant to teach but provides an analysis and covers multiple perspectives
• It increases your knowledge and enhances your experience with food and cooking even if it doesn’t provide you knowledge you can apply practically.