Artificial documentation

Table of Contents

How to use this documentation

This site uses the Diátaxis approach to separate content by what you’re trying to do, whether that’s learning, solving a problem, understanding concepts, or looking up details. This makes it easier to find exactly what you need.

diataxis categories
Figure 1. The Diataxis approach

Content is organised into four categories:

  • Tutorials are learning-oriented lessons that guide you through a series of steps to complete a project. Start here if you’re new to the product and want hands-on practice.

  • How-to guides are goal-oriented instructions that show you how to solve a specific problem. Use these when you know what you want to achieve but need guidance on the steps.

  • Explanation articles provide background context and discuss concepts, design decisions, and why things work the way they do. Read these to deepen your understanding.

  • Reference material contains technical descriptions, API specifications, and detailed parameters. Consult these when you need to look up specific information.

About the Diátaxis approach

Diátaxis recognises that documentation users have different needs at different times. When you’re learning, you need guided practice. When you’re working, you need quick solutions. When you’re curious, you need explanation. When you’re implementing, you need lookup tables.

Traditional documentation often mixes these together, forcing you to hunt through tutorials for API details or wade through reference lists whilst trying to learn. By keeping these modes separate, each piece of documentation can focus on doing one job well, and you can go straight to the type of content that matches what you’re trying to accomplish right now.