-
Notifications
You must be signed in to change notification settings - Fork 0
How To
This section contains guides for users who are already familiar with the tools and techniques covered, but need guidance to achieve a specific goal. They aren't designed to teach users completely unfamiliar with the process, for that, see Tutorials/Home.
From Diataxis:
How-to guides are directions that guide the reader through a problem or towards a result. How-to guides are goal-oriented.
A how-to guide helps the user get something done, correctly and safely; it guides the user’s action.
It’s concerned with work - navigating from one side to the other of a real-world problem-field. How-to guides - task oriented, practical steps, that serve our work
Examples could be: how to calibrate the radar array; how to use fixtures in pytest; how to configure reconnection back-off policies. On the other hand, how to build a web application is not - that’s not addressing a specific goal or problem, it’s a vastly open-ended sphere of skill.
How-to guides matter not just because users need to be able to accomplish things: the list of how-to guides in your documentation helps frame the picture of what your product can actually do. A rich list of how-to guides is an encouraging suggestion of a product’s capabilities.
Well-written how-to guides that address the right questions are likely to be the most-read sections of your documentation.