How the position of the phrase (with the knife) affects the meaning of the following sentences?
- The criminal injured the lawyer with the knife.
- The criminal with the knife injured the lawyer.
Lawyers can have knives! Your sentence must have clarity!
How the position of the phrase (with the knife) affects the meaning of the following sentences?
Lawyers can have knives! Your sentence must have clarity!
Not Recommended:
Three variables are used for CST processing:
Recommended:
CST processing uses the following variables :
Why?
While revewing a guide, you may see something like:
Three variables are used for CST processing:
That is, later the writer added one more varaible, but forgot to change the introductory sentence. We can avoid maintenace by not specifying the number of items in a list.
We all make mistakes. Some mistakes are more serious than others, and sometimes it takes friends and loved ones a long time to forgive and forget. Habits may lead to mistakes. The word HABIT takes me back to an old story. The fellow in the story had a HABIT—he drinks tea a lot. His quest to quit this HABIT was so strong that he managed to reduce the frequency of tea breaks. So, let us see what happened to his HABIT:
1st week: HABIT (A bit of it is there)
2nd week: HABIT (Bit of it is there)
3rd week: HABIT (Still, It is there)
4th week: HABIT(Tea?)
Well, to resolve the core problem, you have to kill many surrounding problems. Let us come to the topic, the mistakes a technical writer makes. Broadly, we can classify the mistakes into two:
Note: This classification is not based on the ground rules of the English language—grammar, usage, mechanics, and style. The impact of these mistakes determines the severity.
Content Related Mistakes:
Any mistake that misleads the user falls under this category.
Examples:
A wrong instruction, incorrect cross-reference, and so on.
Cosmetic Mistakes:
Any mistake that does not mislead the user, but does decrease the quality of the document falls under this category.
Examples:
Incorrect capitalization of headings, incorrect usage of gerund in a heading, and so on.
Though I tried to explain the difference between the two categories, for the benefit of our dubious friends, I would like to present it like:
If a traditional cosmetic-mistake misleads the user, categorize that mistake under the content-related mistakes.
For example, we consider the absence of a serial comma (also known as the Oxford comma) as a cosmetic mistake. But, consider:
Jay: "I am looking for an apartment with three bedrooms, bathroom with shower and kitchen."
Here the serial comma is absent; and it seems like Jay is looking for an apartment with a kitchen in the bathroom!
Let us see how a serial comma can change the meaning:
Jay: "I am looking for an apartment with three bedrooms, bathroom with shower, and kitchen."
[Who knows the rules of punctuations better than our tongue? So, definitely Jay might have got his dream apartment.]
If you ask me which mistake (content related or cosmetic) causes more problems, I would prefer the content related mistakes. Cosmetic mistakes are also mistakes, but if a reviewer finds 5 mistakes—out of which 3 are content related—in my document, I will resolve those 3 mistakes first, followed by the rest.
Here comes a cosmetic mistake in a heading:
How To Operate the Washing Machine
If I review the document, which carries this heading, I will suggest:
Incorrect capitalization. Change to: How to Operate the Washing Machine
Does 'to' make the user's clothes brighter than 'To'? Never! But, an incorrect instruction can make the manufacture's (company's) image dimmer than ever.
Let me conclude my thoughts in a tabular format:
QualityÞ Type of Mistake ß | A perfect document | The document is imperfect, correct the mistakes if possible | Danger! You must correct the mistakes | |
Content-related mistakes | No | No | Yes | Yes |
Cosmetic mistakes | No | Yes | Yes | No |
Word of Omen:
Forgive your girlfriend, if she forgets to wear the necklace that you gifted her. Forget her, if she leads you for a wrong move. Romeos won't agree; so as I.