About Improving "Colour" Documentation.

[KelSolaar]

This article has some good information that could be useful to apply to our documentation: https://www.divio.com/blog/documentation/. The gist of it is a clear delineation between those 4 pillars:

TUTORIALS

A tutorial:

• is learning-oriented
• allows the newcomer to get started
• is a lesson

Analogy: teaching a small child how to cook

HOW-TO GUIDES

A how-to guide:

• is goal-oriented
• shows how to solve a specific problem
• is a series of steps

Analogy: a recipe in a cookery book

EXPLANATION

An explanation:

• is understanding-oriented
• explains
• provides background and context

Analogy: an article on culinary social history

REFERENCE

A reference guide:

• is information-oriented
• describes the machinery
• is accurate and complete

Analogy: a reference encyclopaedia article

[KelSolaar]

I re-organised the README and the Manual to delineate better the various sections as per the above. It was also the occasion to create a How-To Guide.

More to come!

[Myndex]

H @KelSolaar Hi Thomas, and thank you,

"The Grand Unified Theory of Documentation"

I struggle with this a lot, I'm really glad that for whatever reason this old thread suddenly popped up on my "foryou" page here on GitHub, even if for reasons unknown…

That's a very useful link regardless.