A user guide should reflect the product it explains. A simple product with only a few features may need little more than a short, straightforward guide. A product with several modules, different user roles, and multiple setup paths needs more structure. Put all of that information into one flat sequence, and the guide quickly becomes difficult to navigate, especially for someone who is new to the product. Teams that create user guide documentation for complex products need a structure that helps readers navigate that complexity instead of making them sort through it on their own.
Complexity Takes Several Forms
A product can make documentation difficult for different reasons. One feature may require a lot of explanation, while another may be simple. Different people may use the same product in very different ways. Setup can also change from one environment to another, and integrations bring their own instructions into the mix.
- Feature depth. Some features need more than a basic description. They may include settings, optional steps, or situations that require a different approach. The guide needs to cover those details without making the basic task harder to find.
- User roles. An administrator may need instructions that an everyday user never sees. An integrator may need an entirely different set of topics. Putting all of these instructions together can make the guide harder to use.
- Configuration paths. There may not be one setup process for everyone. The steps can depend on the environment, plan, or configuration, so readers need to know which instructions apply to them.
- Connected systems. An integration can add another set of steps to an otherwise straightforward task. Those instructions should be available when needed without becoming part of the main path for users who do not use the integration.
When several of these factors appear in the same product, a flat guide becomes harder to navigate. Readers have to work out which information applies to them before they can get to the instructions they need.
Build the Guide Around the Main Topics
A complex product may have a lot of features, but readers usually come to the guide for a specific task. Showing every option and exception at the start only makes that task harder to find. Keep the information for common tasks easy to reach, and leave the more specialized material for the readers who need it.
A feature can start with the steps most users need, followed by the settings, alternatives, and exceptions that apply to other situations. Someone following the standard setup should not have to work through instructions for configurations they do not use, but those instructions should still be easy to find when they are needed.
Keep Detailed Topics Under the Main Topic
Dr.Explain lets you arrange related topics under a main topic. A feature can have an overview at the top, with separate topics for its settings, procedures, and exceptions. This keeps the main topic focused and puts the extra detail where readers can find it.
Let Readers Open the Details They Need
The topic structure also affects how readers move through the guide. Dr.Explain’s generated help includes a navigable contents tree that follows the structure of the topics. A reader looking for a basic task can stay with the main topics, while someone working through a more involved configuration can open the related subtopics. They do not have to work through sections that are unrelated to what they are trying to do.
One Guide for Beginners and Experienced Users
A complex product does not require a complicated reading experience. When teams create user guide documentation around the way their product is used, beginners can follow the main path while experienced users can move into more detailed topics. Dr.Explain supports this approach with a topic structure that keeps related information together and makes additional details easy to reach. One guide can serve different levels of experience without forcing every reader through the same information.
