Modular documentation questions

Subject: Modular documentation questions
From: "Eric J. Ray" <ejray -at- raycomm -dot- com>
To: TECHWR-L <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 10 Sep 2003 08:05:36 -0600 (MDT)


It's recently become apparent to me that I've been talking
w/ a variety of people about modular documentation,
but we're not communicating because we don't have
common definitions or common understandings. So,
I'm looking for a consensus, of sorts, about what
technical writers mean by the term "modular documentation".

My questions (if you respond to me offline, I'll
summarize--I'd be interested in onlist discussions
of the topic, though):

* Do you currently write "modular documentation"? Why
or why not?
* What _is_ modular documentation? (Please provide
examples or an adequate description for what your
modules look like. Are they paragraphs? Chapters?
Tasks? How do you tell a new writer what to create?)
* Do you reuse/repurpose documentation modules? Why or
why not?

Thanks for any input you can provide,
Eric





Follow-Ups:

Previous by Author: ADMIN: Upgrade and more
Next by Author: Re: Managing documentation in a rapid/agile/extreme programming environment
Previous by Thread: Re: Managing documentation in a rapid/agile/extreme programming environment
Next by Thread: Re: Modular documentation questions


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


Sponsored Ads