Tutorials Style Guide - Example Page Layout

From Help Wiki
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 3)

Figure 1
Figure 2
Figure 3

Brief overview to orient what is being done in this section. May not always be necessary.


Subheading (level 4)

Brief overview to orient what is being done in this section. May not always be necessary.

  1. Numbered step
  2. Start steps with the verb or action to take
  3. Use bold menu steps such as File > Export > Export as PDF
  4. Keep it brief, this is not a place to get chatty
  5. Use hyperlinks embedded in the steps to take folks to relevant articles but don't over do it
  6. Embedded images work well when smallMac network icon.png
  7. 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