What would you like to know more about?

Example Task

This task demonstrates our task content model.

  • The <prereq> element of a task contains prerequisites that the user needs to know or do before starting the current task. Implementations MAY render prerequisite links from the related-links section together with the <prereq> content.
The <context> element provides background information for a task. This information helps the user understand what the purpose of the task is and what they will gain by completing the task. This section should be brief and does not replace or recreate a concept topic on the same subject, although the context section might include some conceptual information.
  1. Write each command in active voice. Do not personify the software or systems.
    If the step needs additional explanation, place the explanation in an <info> element following the <cmd>.
    For example, avoid writing "Ace software walks the user through each step using a mass update wizard." Instead, write "Click Begin to use the mass update tool for modifying multiple profiles at once."
  2. <UI Control> elements are only used in procedures. In other words, we do not use the UI Control element in the context or other paragraphs.
    ChoiceCSS Output
    UI ControlBold
    Window TitleI'm not sure.
    User InputMonospace Courier
    Depending on your choice above, your CSS output will display diffferently.
    This is a step troubleshooting example. If your cat wakes you up too early, lock it out of your bedroom at night.
  3. This is my final command. It's an option.
When the entire task is complete, nothing much changes.
You should not listen to me about the cat. They caterwaul when you lock them out.