Scenario: The developer was seeking documentation to refer users to to answer setup questions for the feature. The setup of the feature, I found, was really complicated. The user needed to select the right combination of choices to properly configure it. The developer suggested the idea of an example setup, where the options are given to successfully set up the feature.
Process: Initially, I created a separate use case example topic. I wanted to use imperative verbs in the tables to guide the user to the correct choices. This didn’t fit within our style guide though. The other problem was that it was fragmented from the other topic. I wanted it to be integrated with the content while the user is setting up the feature.
Solution: I was introduced to the example element.
This enabled me to integrate the use case example within the task topic. The table in the task topic followed the style guide by using short descriptions starting with a noun, and the example element enabled me to use imperative verbs to instruct the user with choices.
The example was also added to the table of contents, integrating the examples further with the task. The example element was an all around win for my documentation purposes.
Double Yew! 