Tutorials Style Guide
From Help Wiki
This style guide is intended for use in the development of workshop/application tutorials in the computing wiki.
Contents
Writing guidelines
Technical writing best practices
- Avoid chattiness or personal opinion. You can insert your personality in the classroom.
- Use clear and concise language
- Hey you, don't use "you"
- Start each step with a verb if possible. What is the person doing specifically?
Formatting conventions
When indicating navigation in the application use bold text and the > to indicate navigational sequence
Example:
- Click Go > Connect to Server
Variable text
Use italics for text that should be replaced by user specific information
Example:
- Enter your username
Page layout
- See Tutorials Style Guide - Example Structure
- Usage of section headers must be consistent
