Category Archives: User Guides

Writing Requirements: Will v Shall v May

When writing requirements or technical documentation, when should you use Will or Shall? Does it make any difference which term you use? Yes. Writing Requirements: Will v Shall v May Let’s look at when you use each. Will indicates intention. “I will fix this PC” (you intend to) “Shall” indicates obligation. It’s close to a […]

How to Create a Worklist for Work Instructions

In the last tutorial, we looked at how to write work instructions. You can also create a worklist for work instructions according to the following criteria: Data on the work instructions, such as: Plant in which the work instructions were created Number of the set of control instructions from which the work instructions were generated […]

How to Write a Software Installation Guide (With Sample Guidelines + Template)

In this tutorial, we look at how to write an Installation Guide. We look at the main sections in an Installation Guide, how to write each section, and provide sample text to help you get started with your technical documents. Instant Download – Buy Here for only $9.99! Download: Click here to learn more about […]

14 Screenshot Guidelines for Technical Documents

The purpose of screenshots is to compliment the text, not replace it. This means that your screenshots compliment what you’ve written and help orient the reader. They also help reduce anxiety in the reader as they can check if they are on the right window. What to capture Identify where the user needs to perform […]

How to Stop MS Word Files From Crashing

If your Microsoft Word files suddenly become huge and start crashing, here’s how to fix it. Sometimes MS Word files explode from 1 to 10 MB in a few minutes? Why? Why Bullet Lists Creates Large MS Word files? The first offender is Bullet Lists. If there is one thing that’s guaranteed to crash Microsoft […]