Difference between revisions of "Tutorials Style Guide - Example Page Layout"

From Help Wiki
m
m
Line 15: Line 15:
 
Brief overview to orient what is being done in this section. May not always be necessary.
 
Brief overview to orient what is being done in this section. May not always be necessary.
 
# Numbered step  
 
# Numbered step  
# Numbered step with link to larger version of figure graphic. [[:Image:Mac calawah1.png | Figure 1]]
+
# Numbered step with link to larger version of figure graphic [[:Image:Mac calawah1.png | Figure 1]]
# Numbered step
+
# Start steps with the verb or action to take
# Numbered step with link to larger version of figure graphic. [[:Image:Mac calawah2.png | Figure 2]]
+
# Use bold menu steps such as '''File > Export > Export as PDF'''
# Numbered step with link to larger version of figure graphic. [[:Image:Mac-calawah3.png | Figure 3]]
+
# Keep it brief, this is not a place to get chatty [[:Image:Mac calawah2.png | Figure 2]]
# Embedded images work well when small[[Image:Mac network icon.png]]  
+
# Use [http://en.wikipedia.org/wiki/Hyperlink hyperlinks] embedded in the steps to take folks to relevant articles but don't over do it [[:Image:Mac-calawah3.png | Figure 3]]
# Numbered step. Use bold text when indicating menus for clicking, i.e. '''Go > Connect to Server'''
+
# Embedded images work well when small[[Image:Mac network icon.png|30px]]  
 
# Urls should be written out fully '''https://studentfiles.evergreen.edu'''  
 
# Urls should be written out fully '''https://studentfiles.evergreen.edu'''  
 +
 +
  
  

Revision as of 15:52, 15 July 2013

Mac network icon.png
Page Summary: Succinct description of what this page is about. Could be two lines worth but shorter is better. Adding an application's icon as a small image can also help orient readers.

Title of tutorial "chunk" (level 2)

Figure 1
Figure 2
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.

  1. Numbered step
  2. Numbered step with link to larger version of figure graphic Figure 1
  3. Start steps with the verb or action to take
  4. Use bold menu steps such as File > Export > Export as PDF
  5. Keep it brief, this is not a place to get chatty Figure 2
  6. Use hyperlinks embedded in the steps to take folks to relevant articles but don't over do it Figure 3
  7. Embedded images work well when smallMac network icon.png
  8. Urls should be written out fully https://studentfiles.evergreen.edu



Additional subheading with collapsed content

For pages with perhaps TOO much content, collapsing non-critical sections can help users not feel so visually overwhelmed

Collapse-small-silver.png
show less
Expand-small-silver.png
show more
  • Use the a collapsed section for "nice to know" information
  • Do not put critical info in here as it may not be seen by users



See also