Skip to content

user-guide-diataxis — guides

user-guide-diataxis is the docs skeleton for your product: the four Diátaxis kinds — tutorials, how-to, reference, explanation — plus the new-guide skill that lands every new page on the right side of the line. One kind per page, never blended. The link-out discipline does the rest.

New here? Read About the Diátaxis framework first — it's the model. Then write your first page with How to write a guide.

Tutorials

Learning-oriented, start-to-finish.

None yet. The new-guide skill scaffolds one from a template the moment you need it.

How-to

Task-oriented recipes for a problem you already have.

  • Write a guide — use new-guide to settle the audience contract, pick the kind, and draft from the matching template.

Reference

Information-oriented, dry and complete.

None yet. Reference pages are the prime candidate for generation from your own schemas and --help output.

Explanation

Understanding-oriented — the why behind the design.

Cross-cutting guides — installing the catalogue, upgrading packs, the adapter support matrix — live in ../_shared/.