Difference between revisions of "Tutorials Style Guide"
From Help Wiki
(→Writing guidelines) |
|||
| Line 23: | Line 23: | ||
====Punctuation and Capitalization==== | ====Punctuation and Capitalization==== | ||
*Start all numbered steps with a capital | *Start all numbered steps with a capital | ||
| − | *Do not punctuate the end of bulletted or numbered lists (no periods) | + | *Do not punctuate the end of bulletted or numbered lists (no periods)<br /> |
| + | '''Example:''' | ||
| + | #This is my first step | ||
| + | #This is my second step | ||
| − | + | ||
| + | ==Page layout== | ||
* See [[Tutorials Style Guide - Example Structure]] | * See [[Tutorials Style Guide - Example Structure]] | ||
* Usage of section headers must be consistent | * Usage of section headers must be consistent | ||
Revision as of 12:08, 24 October 2007
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
Punctuation and Capitalization
- Start all numbered steps with a capital
- Do not punctuate the end of bulletted or numbered lists (no periods)
Example:
- This is my first step
- This is my second step
Page layout
- See Tutorials Style Guide - Example Structure
- Usage of section headers must be consistent
