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===
+
 
 +
==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 13:08, 24 October 2007

This style guide is intended for use in the development of workshop/application tutorials in the computing wiki.

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

Navigational Sequence

When indicating navigation in the application use bold text and the > to indicate navigational sequence
Example:

  1. Click Go > Connect to Server

Variable text

Use italics for text that should be replaced by user specific information
Example:

  1. 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:

  1. This is my first step
  2. This is my second step


Page layout