RE: Baiting for the single source rant

[FHuppert -at- envirosys -dot- com]

Single source publishing, in regards to software documentation and help
systems, means maintaining a single source document set that is used to
generate printed manuals and help systems (WinHelp, HTML, Java enabled,
etc.).  While this often means producing one set of text that is presented
is multiple formats, it can go much further.

A quality project includes content that is left out of the printed document
but included in the Help files, based on the format and needs of the target
software user. It will also typically include the reverse: text that is
left out of the help files but included in the printed documents, whether
hard-copy or PDF format.  A variety of tools are available, with varying
advantages based on the writer's target market and product types.

People learn in many ways, including by reading, hearing, watching, and
doing.  A quality documentation/help/tutorial project will address the
needs of the user and provide information when and how it best suits the
customer in their typical use of the software.

Fred M. Huppert
Tech Writer/Help Author
Environmental Systems Corp.



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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.  http://ieeepcs.org/2001/

  +++  Miramo -- Database/XML publishing automation.  See us at  +++
  +++  Seybold SFO, Sept. 25-27, in the Adobe Partners Pavilion  +++
  +++ More info: http://www.axialinfo.com  http://www.miramo.com +++

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