How to do something. Literally an introduction followed by a step by step procedure.
Checklist
- One paragraph to explain what you are doing
- Procedure captured as a sequence of steps
- Don't waste time with a screen snaps; link to the reference section
- Don't waste time with a description; link to the concept section
- Don't name the page "How to add a shapefile layer", be positive "Adding a shapefile layer"
- Wait for the user list to ask How and the describe with a tasks page
Good examples
Comments
Task topics tell users how to do something. Users who access task topics typically are focused on the job at hand, so provide them with a procedural presentation of the information they require. Task descriptions are step-by-step instructions for performing specific actions and tasks in the platform. For example, the Tasks section contains step-by-step instructions for creating a repository location, and for importing a file from the file system into the workbench.
Task topics are comprised of the following sections:
- A brief introductory section, which helps orient the user to the task.
- A procedure, which is a series of steps that describes how to accomplish a specific goal.
Use links to direct the user to related information; task topics do not provide conceptual information or present reference material.