Re: Modularization of Documentation

Subject: Re: Modularization of Documentation
From: "Bill Swallow" <techcommdood -at- gmail -dot- com>
To: "Tony Markos" <ajmarkos -at- yahoo -dot- com>
Date: Thu, 8 Jun 2006 09:32:13 -0400

Just about every technical writing book I've ever read discusses this,
Tony. They don't use your buzzwords, but the concept is as old as
dirt. Perhaps you have heard these buzzwords: clear, concise, direct.

If you're looking for cold hard use of your terminology, you're not
going to find it outside a niche collection of resources, because
terminology is marketable and can become dated. But the concept of
module, as you have just described it, can be dated back to even cave

That is, if I understand your definition correctly. I'm having trouble
determining what you mean by "skips and jump-to's" and "chunk of
documentation". But it sounds like your definition is the same as the
many others that are used throughout the techcomm world, minus the
buzzwords; the underlying goals are the same.

On 6/8/06, Tony Markos <ajmarkos -at- yahoo -dot- com> wrote:

Below is a copy of what I posted yesterday:

Module: A highly cohesive (singular of purpose) and
losely coupled (minimization of interfaces and/or
skips and jump to's) function, or chunk of

What I want to know is what book gives specifics as
how to create highly modular docs - using the above
definition of module. Betcha such a book does not

Bill Swallow
HATT List Owner
WWP-Users List Owner
Senior Member STC, TechValley Chapter

WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content delivery. Try it today!.
Doc-To-Help includes a one-click RoboHelp project converter. It's that easy. Watch the demo at

You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-
To unsubscribe send a blank email to techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

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

Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit for more resources and info.

Re: Modularization of Documentation: From: Bill Swallow

Previous by Author: Re: Modularization of Documentation
Next by Author: Re: Using a warning notice for Television Owner's Manuals
Previous by Thread: Re: Modularization of Documentation
Next by Thread: Re: Modularization of Documentation

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

Sponsored Ads