RE: Repetition is the mother of...

Subject: RE: Repetition is the mother of...
From: "Dan Goldstein" <DGoldstein -at- riverainmedical -dot- com>
To: <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 20 Apr 2011 12:26:18 -0400

I have no preference. This is a classic document requirement question
that tech writers pose to the customer/client/boss/collaborator. If we
don't know and can't ascertain what the reader(s) would prefer, we make
an educated guess.

A disadvantage of repetition is that some readers dislike the increased
document size. A disadvantage of linking is that some readers dislike
following links.


-----Original Message-----
From: McLauchlan, Kevin
Sent: Wednesday, April 20, 2011 12:14 PM
To: techwr-l -at- techwr-l -dot- com
Subject: Repetition is the mother of...

If your WebHelp or PDF customer document had a couple or three places
where a user might legitimately have use for a piece of information,
would your preference be:

a) put the info where it might be useful, even if it's repeated on
several pages (perhaps use a snippet or variable), like the
configuration/setup section, the concepts section, the admin section, or

b) put the info on the most likely page, then put links to that page on
any other page where there might be a need , but don't physically repeat
any info more than once ?

Why?
Why not?

For bonus points, what do you think of the notion of explaining things
differently in different places?
Different wording, different emphasis, possibly different examples.
Does that:

a) help people who have different backgrounds or different ways of
grasping things, or

b) add clutter, bloat, and potential confusion

?



This message contains confidential information intended only for the use of the addressee(s). If you are not the addressee, or the person responsible for delivering it to the addressee, you are hereby notified that reading, disseminating, distributing, copying, electronic storing or the taking of any action in reliance on the contents of this message is strictly prohibited. If you have received this message by mistake, please notify us, by replying to the sender, and delete the original message immediately thereafter. Thank you.

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Create and publish documentation through multiple channels with Doc-To-Help.
Choose your authoring formats and get any output you may need. Try
Doc-To-Help, now with MS SharePoint integration, free for 30-days.
http://www.doctohelp.com

---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/ for more resources and info.

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat


Follow-Ups:

Previous by Author: RE: Word doc review, collaborative editing, and signoff
Next by Author: RE: Word doc review, collaborative editing, and signoff
Previous by Thread: RE: Audacity crashes on remote start
Next by Thread: RE: Repetition is the mother of...


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads