Contents

Configuration Example: What To Do when Configuring X and Y

Here’s where you:

Briefly outline what your configuration example is about so that users immediately know how relevant the information is to them and whether it’s worth their while to read.

OR

Briefly tell the story of a real-world or fictional scenario that sets your configuration example in context for users. Your scenario could illustrate how an existing process works, the problems involved, and the solution that would resolve it – which is basically why you’re providing this configuration example!

Before You Begin Title

Let users know if they need to complete any configuration or have anything in place before they can complete your configuration example. Also consider what your readers already know or should know about this configuration. If it’s helpful for them to know a little more conceptual theory before they configure anything, share that information and put things in context here.

Configuration Procedure

Tell users the steps they need to do to complete the configuration task. You can just describe each step in text, but if you have screenshots to show each step visually, all the better! Either way, it’s best to keep the number of steps in your procedure to between 7 and 9 so as not to overwhelm your reader with too much information in one go – feel free to divide a long example into sub-procedures as you see fit!

Write each step that users need to do to complete the procedure. \\ with or without screenshots

1. Write Step 1

2. Add Step 2..

3. Add Step 3..

4. Finally sum up with a step that tells users how to verify your configuration

Related Topics

If you know of other ‘need to know’ or ‘nice to know’ related topics, give users the links to learn more.