Tutorials

If a Getting Started guide showcases what’s best about your product and gets new users started on their journey with you, then tutorials, sometimes called how-tos or guides, take them on the next steps.

As you might expect, the breadth and detail of tutorials or guides depends on your project, but here’s my general advice.

If your product or project has identifiable sections or sub-projects, they need tutorial sections. Do you support different ways to use your product – for example, a Command-Line Integration (CLI) tool, a visual interface, and an Application Programming Interface (API)? Perhaps you also support continuous integration (CI) or have applications and plugins in third-party marketplaces? If so, all of these need at least one tutorial on how to use them. If one of these sub-areas is particularly complex – for example, the visual interface has many different sections, or the Software development kit (SDK) consists of several components...