Size of Modules for Single Sourcing

[Lisa Kemp <lnk -at- ontario -dot- com>]

We recently started writing for a new online help system. We are writing
modules/topics instead of chapters. A module contains the What Is, Why Use,
and How to about a topic or multiple topics., and each file contains a
module. We are disagreeing on how to combine/split modules, and I thought
those of you into online help and using single sourcing methodology could
help.

Method 1
The modules break into the smallest subtopics, so we would have overview
modules of larger topics that would link to the detailed modules about that
topic. This creates a hierarchy of modules in the file system.
Example:

Options Overview module - Explains about options and links to the main
options modules (system options, inbound options, outbound options, deleting
options, copying options)
	System Options module
	Inbound Options module
		Hold Options module
		Messaging Options module
	Outbound Options module
	Deleting Options module (These are the ones people tend to want to
combine.)
	Copying Options module

Benefits of this method:
*	Smaller pieces so you can pick and choose for reuse without scanning
a large module
*	Shorter modules to read online (can read by concept or by module),
thus less scrolling

Disadvantages of this method:
*	Lots more modules
*	Lots more linking to separate modules

Method 2
The modules are combined by topic.

Example:
Options module - Explains about options and links to the options concepts
(What Is for system options, inbound options (including Hold Options and
Messaging Options), outbound options, deleting options, copying options)

Benefits of this method:
*	Our XML tool doesn't support linking across files, so this method
provides the ability to follow links within one file
*	Less jumping from module to module but with the same amount of links
(Will this make a difference to the user?)

Disadvantages of this method:
*	Could lose readers who look at an entire module online
*	Not as easy to pick and choose smaller topics for reuse
	
Any help would be greatly appreciated.

Lisa Kemp

Manager, Technical Communications
Client Services
Ontario Systems
Tel 765.751.7000
Fax 765.751.7499


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

Collect Royalties, Not Rejection Letters! Tell us your rejection story when you 
submit your manuscript to iUniverse Nov. 6 -Dec. 15 and get five free copies of 
your book. What are you waiting for? http://www.iuniverse.com/media/techwr

  Your monthly sponsorship message here reaches more than
  5000 technical writers, providing 2,500,000+ monthly impressions.
  Contact Eric (ejray -at- raycomm -dot- com) for details and availability.

---
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.