Skip to Main Content

Pennell - ENGL 3309

Dr. Pennell's Technical Writing course concentrating on Document Design

Assignment document

Hints and Tips

For this assignment you will be creating an instruction manual.  You need to be detailed, descriptive, and accurate.

  • Once you choose your topic you can search YouTube for videos to help you identify the process. In most cases you will search "how to..." Watch multiple videos to have a complete process for your instructions.
  • Use your phone to take pictures of the process and use them in your instructions.
  • You are not creating a lookbook like Ikea.  You will need to write the step by step instructions that someone can follow.

Below are highlights of two sections from Tips for writing user manuals:

How to give instructions

  • Provide step-by-step sequences in the correct order.
  • Provide visual stepping stones (e.g. Step 1, Step 2 etc.)
  • Avoid lengthy paragraphs.
  • Use everyday words and terms: avoid jargon.
  • Explain symbols, icons and codes early.
  • Do not assume the user has prior experience or product knowledge.
  • Write in the present tense and the active voice.

How to design individual pages in the user manual

  • Ensure that font size is adequate (use at least 12 point font).
  • Ensure high text-to-background contrast (black on white is best).
  • Use san-serif fonts.
  • Avoid using multiple font styles.
  • Font weight can be used sparingly to denote importance.
  • Use color coding consistently.
  • Provide plenty of white space between sections and around images and paragraphs.
  • Test your use of colors to ensure they can be read by color-blind users.