RE: Content Moratorium

Subject: RE: Content Moratorium
From: Jim Shaeffer <jims -at- spsi -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Mon, 26 Mar 2001 08:58:24 -0500

One thing to keep in mind when handling chaos is to documument in a modular
That is, confine each subject to one place (one topic, one chapter, whatever
granularity suits you).
If the same information is applicable somewhere else, use a cross reference.
If your tools/techniques are sophisticaed enough, you can use the cross
references to actually place the information in different parts of the
documentation when you generate it, otherwise, the user must jump from place
to place.
Users do not like to jump from place to place, but it's better on all
concerned than having self-contracictory and out-of-date information
published because there wasn't enough time to remember and cross check all
the places you had it in the documnets.

Jim Shaefer (jims -at- spsi -dot- com)


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

A landmark hotel, one of America's most beautiful cities, and
three and a half days of immersion in the state of the art:
IPCC 01, Oct. 24-27 in Santa Fe.

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.

Previous by Author: RE: naming methods in manuals
Next by Author: RE: Plays well with others
Previous by Thread: RE: Content Moratorium
Next by Thread: Health insurance for contractors

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

Sponsored Ads

Sponsored Ads