Re: What goes in which kind of document?

Subject: Re: What goes in which kind of document?
From: Bonnie Granat <bgranat -at- att -dot- net>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Fri, 11 May 2001 07:19:06 -0400

Becca Price wrote:
> I'm reorganizing our Administrator's Guide along strict
> task-oriented lines: what does the Admin want to do, and how do
> you do it with our software. I'm putting all the interface
> information (field definitions, how to use specific screens,
> etc) in the help file.
> I know that single-sourcing is the Holy Grail of techwriting (I
> read so on this list, after all, so it must be true!) but my
> proposed content division is designed to cut down redundancy
> between documents.
> Does my proposal make sense?

That's exactly what we do, Becca, and we
have links to online books (PDF and
HTML) where appropriate.
Bonnie Granat
Technical Writer and Editor


*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available now at or info -at- devahelp -dot- com

Sponsored by Information Mapping, Inc., a professional services firm
specializing in Knowledge Management and e-content solutions. See or 800-463-6627 for more about our solutions.

You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit for more resources and info.

What goes in which kind of document?: From: Becca Price

Previous by Author: Re: Chapter-number redundancy
Next by Author: Re: sugestions needed for teaching a introductory college course in technical writin
Previous by Thread: What goes in which kind of document?
Next by Thread: Apple Style Guide URL

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

Sponsored Ads