Technical writing needs to be objective. When different people read the technical notes, they should be able to perform the same tasks and get the same results.
To do this, the words you use must not be open to a wide range of interpretations.
One way to achieve this is to remove a "very" qualifier from the vocabulary, because the exact meaning of "very" varies from person to person.
For example, what is the difference between "network shutdown" and "network really shut down"? No. Then why do you want to use it?
Similarly, a "very thin" motherboard may actually be "thin" and it is difficult to distinguish it unless it is "thin". That's why talking about a "0.2-inch thin motherboard" is much better called "very thin" and leaving it.
The following are other qualifiers to avoid in the technical documentation:
"Impossible", "impossible", "impossible", "impossible", "impossible", "incomprehensible", "unprecedented", "incalculable", "amazing", "quite large".
Another important rule in objective writing is to observe how you speak to the audience and refer to your sentence topic.
For example, if you use a second person singular pronoun at the beginning of the page [such as "You must enter your ID and password to access the card database"], don't just switch to the sentence after the "user" language [eg "User must enter him" The code can access the operating room"].
This switching between subject references confuses the reader. Just choose a sound and stick to it through the technical documentation.
Orignal From: Technical Writing - How to write objectively and avoid the qualifier "very" as a technical writer
No comments:
Post a Comment