User Guides

User manual writing involves providing clear instructions on how to perform actions on a device or a software application. The persistent question is, how can we write an effective user manual? As the name suggests, the manual is for the user. That's why when we at Global Web Technologies take up user manual writing; we make it a point to understand the following about the user:

  • Who will read this manual? Remember that age, sex, region, etc will determine the tone of the manual
  • Why does the user need the manual?
  • What does and does not the user already know? This will determine the scope of the manual.
  • How does the user want the information to be presented; as a printed manual or as a web-based help integrated with the software?
  • Who will read this manual? Remember that age, sex, region, etc will determine the tone of the manual
  • Once we have answers to the above questions, we start the user manual writing process with the Table of Contents.

The effectiveness of a user manual depends on the clarity of instructions. To achieve this, our user manual writing services involves keeping in mind the following principles:

  • We begin every instruction with an action word.
  • We address the user as either You or User and maintain consistency.
  • We use active voice in the instructions; it will help contain confusion.
  • We don't forget to Keep It Short and Simple; simpler the instructions, easier it is for the user to follow. Also, we keep in mind that it will reduce localization costs.
  • We ensure conciseness and precision by restricting the length of instructions – one sentence for each action that the user is expected to perform.
  • We ensure consistency in the words/names and style used; it will ensure user-orientation of the manual.
  • We use illustrations, graphics or images wherever required.
  • Having adhered to the above principles, we also include the standard components before designing a manual.