TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
> I think it is exactly an issue of reading comprehension.
> In a lowest common denominator environment, if you say
> "choose the colors for your screen," I would bet real
> money that someone will ask "how do I know which colors
> I should choose?"
And you'd win the bet because "Choose the colors for your screen" is not a
clear instruction, although it is certainly possible to argue that it is
"clear enough" for a given audience in a given situation.
It isn't clear because it doesn't specify the relation between choosing
and the outcome.
Another common variant is "Choose the colors that your screen will be."
Huh? I'm supposed to predict? Do I get a clue? What do I win if I guess
It's weak syntax. Technical writers are supposed to know better. Clear
writing isn't just about being understood. It's about removing any
possiblilty of being misunderstood.
Regarding the original post -- yes, "appropriate" is an empty filler that
should be avoided unless accompanied by a reference or hyperlink to
specific criteria the user can apply to determine what is or is not
"Relevant" is another one, as in "Choose the relevant account type".
"Appropriate" and "relevant" are earmarks of writing done by people who
think it's important to sound "technical" irrespective of making sense.
And so is blaming any misunderstandings upon our readers' "stupidity"
rather than our own ambiguous syntax.
Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control! http://www.helpandmanual.com/
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-