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: "always read and follow the instructions" From:Gause_Brian -at- emc -dot- com To:<techwr-l -at- lists -dot- techwr-l -dot- com> Date:Tue, 3 Jun 2008 17:59:24 -0400
I agree that this is pointless text.
Short example: I was watching my roommate attempt to put together his
new TV stand a couple weeks ago. When he started to have issues missing
a couple screws, he couldn't figure it out. Sitting nearby, watching his
struggle, I reminded him, "You should check the documentation." About 5
times, I reminded him. Eventually, he gave up and skipped the two
screws...
Some people wouldn't read documentation if you paid them. Silly warnings
(inside the book) are just a complete waste.
Now, if you could get your CHM file (or PDF) to (randomly and
repeatedly) launch an mp3 file which speaks the words "Always read and
follow the instructions in your user's guide", then you've got something
useful. :)
Brian Gause
P.S. The only acceptable time to tell users to follow instructions is
something like this "Be sure to read the complete set of instructions
before beginning your task."
-----Original Message-----
From: techwr-l-bounces+gause_brian=emc -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+gause_brian=emc -dot- com -at- lists -dot- techwr-l -dot- com] On
Behalf Of Susan W Gallagher
Sent: Tuesday, June 03, 2008 1:59 PM
To: TECHWR-L
Subject: Re: "always read and follow the instructions"
Idunno if I see any practicality in the statement other than CYA. <g>
Presumably, if the user opens the book, it would be to read the
instructions
so the admonition is moot. If the user doesn't open the book, what good
does
putting the admonition in the book do? The user won't see it. No?
-Sue Gallagher
On 6/3/08, Milan Davidovic <milan -dot- lists -at- gmail -dot- com> wrote:
>
> When I see a statement in a manual such as "Always read and follow the
> instructions in this manual", two thoughts come to mind:
>
> - Following the instructions in the manual (i.e. the ones actually in
> the manual, not the instructions you imagine) presupposes having
> learned them, so the direction to "read" them is redundant.
> - Telling someone to "do x" with no qualifiers provides no options,
> so the modifier "always" is redundant.
>
> Do you think "always read and follow the instructions" is likely to be
> more effective than "follow the instructions"? Do you think it depends
> on the context?
>
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create HTML or Microsoft Word content and convert to Help file formats
or
printed documentation. Features include support for Windows Vista & 2007
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as gause_brian -at- emc -dot- com -dot-
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
