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.
Subject:RE: The 'user' in User Manual From:"Lauren" <lt34 -at- csus -dot- edu> To:"'Ned Bedinger'" <doc -at- edwordsmith -dot- com> Date:Sat, 3 Feb 2007 11:58:38 -0800
Ah. I see. Well with respect to writing, I will comment. Consistency for
the sake of consistency can lead to confusion because form will override
function. Consistency in habit will tend to lead to consistent documents
because the writer can focus on function since form is the habit. So back
to my original claim of consistency that I tend to use in the real world,
whatever you decide about form, be consistent. To add to that, regular
consistency over time will become habit.
From: Ned Bedinger [mailto:doc -at- edwordsmith -dot- com]
Sent: Friday, February 02, 2007 11:56 PM
Subject: Re: The 'user' in User Manual
> I've never heard the phrase "the old saw about foolish consistency."
> When did consistency become foolish? I might not understand what you
> are are saying here.
"A foolish consistency is the hobgobblin of little minds."
The writer of your Tester's Manual (that was it wasn't it?) took the rule of
consistency, applied it to the techwriting convention of addressing the
audience as 'you', and produced a document that reputedly has the word 'you'
in every sentence. I think this is a foolish consistency.
The quote is from "Self-Reliance", an essay from 1841, by Ralph Waldo
Emerson. True lions of technical writing will want to read it. True tech
writers will find much to quibble with in it. Anyway, here's the last
paragraph, where 'foolish consistency' and at least one other oft-quoted
line come from.
A foolish consistency is the hobgoblin of little minds, adored by little
statesmen and philosophers and divines. With consistency a great soul has
simply nothing to do. He may as well concern himself with his shadow on the
wall. Speak what you think now in hard words and to-morrow speak what
to-morrow thinks in hard words again, though it contradict every thing you
said to-day.--"Ah, so you shall be sure to be misunderstood."--Is it so bad
then to be misunderstood? Pythagoras was misunderstood, and Socrates, and
Jesus, and Luther, and Copernicus, and Galileo, and Newton, and every pure
and wise spirit that ever took flesh. To be great is to be misunderstood. .
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include single source authoring, team authoring,
Web-based technology, and PDF output. http://www.DocToHelp.com/TechwrlList
Now shipping: Help & Manual 4 with RoboHelp(r) import! New editor,
full Unicode support. Create help files, web-based help and PDF in up
to 106 languages with Help & Manual: http://www.helpandmanual.com
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-