Modularization of Documentation

[Tony Markos <ajmarkos -at- yahoo -dot- com>]

--- siliconwriter -at- comcast -dot- net wrote:

I would like to modularize (is that a word?) the
content of the technical notes, along with the
drawings, images, and tables that accompany them.
Then I would like to........

Tony Markos responds:

Modularize is most definetly a word! It goes like
this:

*  The main skill of a TW is skill in structured
writing and, as Charles Horn (the guy who popularized
structured writing) states on the Infomaping Web site:
"Structured writing is really all about analysis."

* And, one of the main things that anlysis is all
about is properly partitioning ("chunking" to us TWs).

*  And proper partitioning is all about coming up with
"chunks" of content that are highly cohesive (i.e.,
about one thing) and losely coupled (i.e.,
minimization of the reader having to do skips and
jump-to's between "chunks").

*  And to say that content is highly cohesive and very
loosley coupled is to say that the content is very
modular.

Unfortunately, you are going to find very little
written material in the TW community on how to
properly modularize your work.  It involves use of
taboo engineering techniques. 

Tony Markos
"Discover the true meaning of life; always drive
within posted speed limits." - AJ Markos



__________________________________________________
Do You Yahoo!?
Tired of spam?  Yahoo! Mail has the best spam protection around 
http://mail.yahoo.com 
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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!. http://www.webworks.com/techwr-l 

Doc-To-Help includes a one-click RoboHelp project converter. It's that easy.  Watch the demo at http://www.DocToHelp.com/TechwrlList

---
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 http://lists.techwr-l.com/mailman/options/techwr-l/archive%40infoinfocus.com


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
http://www.techwr-l.com/techwhirl/ for more resources and info.