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 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
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.
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
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-