RE: Repetition is the mother of...

Subject: RE: Repetition is the mother of...
From: "McLauchlan, Kevin" <Kevin -dot- McLauchlan -at- safenet-inc -dot- com>
To: Dan Goldstein <DGoldstein -at- riverainmedical -dot- com>, "techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 21 Apr 2011 11:14:52 -0400

I normally write up a new concept or procedure according to
how it was intended to be used by whatever lead customer or
industry was the driving force behind getting a feature
included.

But, our products being the sorts of things they are, when
they're out in the world for a while, they start getting
picked up by new customers who have different reasons for
buying, whose industry uses a different terminology, or
who otherwise come from a different milieu or mindset.

Once I grasp the difference, if it's not practical to
simply tweak the current pages that deal with that aspect
of the product, it's easy to just create another help
topic or two. As other people have observed, help is normally
not accessed in any pre-determined order. You can give it
a bit of structure with ToC, but most people resort to
the Search box first and look at the ToC only as an aid
to orientation or a memory prompt... a source of possible
keywords to plug into the Search field.

-----Original Message-----
From: Dan Goldstein
Sent: Wednesday, April 20, 2011 12:26 PM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: RE: Repetition is the mother of...

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.


The information contained in this electronic mail transmission
may be privileged and confidential, and therefore, protected
from disclosure. If you have received this communication in
error, please notify us immediately by replying to this
message and deleting it from your computer without copying
or disclosing it.


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

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


References:
RE: Repetition is the mother of...: From: Dan Goldstein

Previous by Author: RE: Flare question: Orphan xref tags in HTML that don't appear in WYSIWYG editor but do appear in build
Next by Author: graphics designer needed for logo help
Previous by Thread: RE: Repetition is the mother of...
Next by Thread: Re: Thanks to Respondents: Payment Delay in 1099 Employment Contract


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

Sponsored Ads


Sponsored Ads