Instructional style
The instructional style used for developing Software Help resources should:
- Break the steps of a software process into small components (chunks).
- Focus on the steps and provide minimal underpinning theory.
- Use plain language with a minimum number of words.
- Incorporate screen captures for clarification.
- Include arrows and number graphics to direct focus to specific elements of a screen capture. Download graphic elements.
- Use bullet points
to describe the steps in a process.
Note: Bullet format should only be used for instructional steps. Supporting information should be formatted as Normal . - Use numbered points to describe an ordered sequence that relates to number labels on a screen capture.
- Use an active voice and begin sentences with a verb. For example: "Re-name the folder." instead of "The folder should be re-named." and "Select the assignment" instead of "Make a selection from the list of assignments".
- Don’t use “Click” to describe the action of selecting an interactive component. A touch screen or adaptive technology user cannot “click”. It is best to use the term “Select”.