Tutorials Style Guide

From Help Wiki
Revision as of 13:09, 24 October 2007 by Greenea (Talk | contribs)

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

# Click Go > Connect to Server 

Variable text

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

# 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)
#This is my first step
#This is my second step

Page layout