Difference between revisions of "Tutorials Style Guide"

From Help Wiki
(Writing guidelines)
Line 11: Line 11:
 
====Navigational Sequence====
 
====Navigational Sequence====
 
When indicating navigation in the application use bold text and the '''>''' to indicate navigational sequence <br />
 
When indicating navigation in the application use bold text and the '''>''' to indicate navigational sequence <br />
'''Example:'''
+
'''Example:'''
# Click '''Go > Connect to Server '''
+
# Click '''Go > Connect to Server '''
 
----
 
----
  
 
====Variable text====
 
====Variable text====
 
Use italics for text that should be replaced by user specific information <br />
 
Use italics for text that should be replaced by user specific information <br />
'''Example:'''
+
'''Example:'''
# Enter your ''username''
+
# Enter your ''username''
 
----
 
----
  
Line 24: Line 24:
 
*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)<br />
 
*Do not punctuate the end of bulletted or numbered lists (no periods)<br />
'''Example:'''
+
'''Example:'''
#This is my first step
+
#This is my first step
#This is my second step
+
#This is my second step
  
  

Revision as of 13:09, 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:
# 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