Tutorials

A tutorial is a lesson that takes the reader by the hand through a series of steps to complete a project of some kind.

diataxis.fr/tutorials

Tutorials are learning-oriented. The reader is a beginner. They follow what the author tells them, step by step, and at the end they have built something they didn’t know how to build before.

Authoring guidance

When adding a tutorial to this section:

  • Hand-hold. Assume the reader is new not only to this SDK but possibly to its underlying tools.

  • Make every step succeed before introducing the next one. A failing step early in a tutorial loses the reader entirely.

  • Don’t explain why. That’s the job of Explanation. A tutorial shows that something works; the explanation says why it has to.

  • Lead the reader to a concrete, working result — something they can run, see, or share.

  • Avoid choices. Pick one path and walk it. Alternatives belong in How-to guides.