Difference between revisions of "Tutorials Style Guide"

Revision as of 12:04, 24 October 2007

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

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?

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

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

@@ Line 21: / Line 21: @@
 ===Page layout===
+* See [[Tutorials Style Guide - Example Structure]]
 * Usage of section headers must be consistent
-'''Example structure for tutorials'''
-==Title of tutorial "chunk" (level 2)==
-[[Image:Mac calawah1.png|thumb|250px|right|Figure 1]]
-[[Image:Mac calawah2.png|thumb|250px|right|Figure 2]]
-[[Image:Mac-calawah3.png|thumb|250px|right|Figure 3]]
-Brief overview to orient what is being done in this section. May not always be necessary.
-===Subheading (level 3)===
-Brief overview to orient what is being done in this section. May not always be necessary.
-# Numbered step
-# Numbered step with link to larger version of figure graphic. [[:Image:Mac calawah1.png | Figure 1]]
-# Numbered step
-# Numbered step with link to larger version of figure graphic.. [[:Image:Mac calawah2.png | Figure 2]]
-# Numbered step with link to larger version of figure graphic. [[:Image:Mac-calawah3.png | Figure 3]]
-# Embedded images work well when small[[Image:Mac network icon.png]]
-===Subheading (level 3)===
-Brief overview to orient what is being done in this section. May not always be necessary.
-# Numbered step. Use bold text when indicating menus for clicking, i.e. '''Go > Connect to Server'''.
-# Urls should be written out fully'''https://studentfiles.evergreen.edu'''
-===See also===
-*[[Connect to Hurricane - Mac OS X]]