Correctness. Consistency. Clarity. This is a must for any technical writing deliverable. You cannot compromise on either of these elements. As a technical writer, you have to stick to this 3Cs.
Correctness
Imagine your Help as your GPS system in your car. What would happen if your GPS takes you on a long ride or shows you some incorrect navigation! Imagine the level of frustration that can mount on your mind! Same happens with your readers if your Help lacks accuracy.
Your readers have opened the Help since they are stuck in a problem. It is very important to understand How and Why did a reader search for the Help in first place. Your Help has to be accurate enough to solve their problems unless they are reading a wrong answer for a right question!
Consistency
Your GPS system sometimes highlights the slowdown with red color, sometimes with yellow color. It sometimes marks the destination with a blue symbol and a couple of times with pink! What would happen? Similarly, if your Help lacks uniformity, the readers will rather need another Help to figure out the conventions. Your write-up needs to be consistent across the guide. Once you establish a tone, you shouldn't change it unless really needed.
Clarity
Your GPS system starts showing trees, clouds, the parked vehicles, and probably some pedestrians too. Do you really need all these elements to be shown when your motive to use GPS is only to navigate it to a specific destination. Likewise, you don't need to overdo your Help. Keep it simple. Keep it clear. Don't overload it with too much information. Understand the question before you answer!
No comments:
Post a Comment