Technical writing failed when trying to become "fine writing" or "creative writing." why? Because one of the main tools of "fine writing" is to attribute human traits to non-human actors and agents. This is a clear contraindication in the technical documentation.
For example, the error is submitted each time a sentence is written, such as "When the system is aware of the user's choice, it switches channels."
"Consciousness" is the property of organic [human, animal, and sometimes even plant] consciousness. Machines and computer systems are not "aware of" the way we humans are aware of things.
A better sentence is: "When the system detects a user selection, it switches channels." Here, no one claims that "system" and "consciousness" are "alive."
When technical writers use adjectives, top-level, and exaggerate pictures of state of the art and processes, they make the same "fine writing" mistakes.
For example, in the novel, when the user presses the OFF button, talking about "the gorgeous pomegranate red light" may be commensurate with "poetry permission." But in a technical paper, this exaggerated description is ridiculous.
A better description is "The red indicator lights up when the user presses the OFF button." It is simple, correct and effective.
Say it again: "When you hear the terrible sound of the B module, it's time to change the oil." The adjective "bad" is not technical writing, because its meaning is subjective and can be changed from one person to another. Technical documentation needs to be as objective as possible to eliminate any changes in the application.
A better sentence is: "When you hear the treble from the B module, it's time to change the oil."
Orignal From: Technical Writing - How to Avoid Exaggeration and "Fine Writing" as a Technical Writer
No comments:
Post a Comment