Mastodawn

I love this — a guide for a Documentation System: https://documentation.divio.com/introduction/

It's all about the difference between tutorials, how-to guides, references, and explanations — distinctions I often have trouble making when covering Shortcuts.

The original Workflow documentation I made was mostly reference material, hence why it's still difficult to truly learn from

Introduction - Documentation System

Find an introduction to how Divio formats and uses documentation. Our approach is to make documentation work for everyone. Learn why this is important here.

Show thread

Marek Fořt Feb 13, 2023

@matthewcassinelli Thanks for sharing. Lots of documentation websites are written by developers who might not be necessarily great writers (hello, that's me). These seem like good guidelines to go by, I like how it forces one to think about the purpose of what they're writing.