Four flavors of GUI

[geoff-h -at- MTL -dot- FERIC -dot- CA]

 Matthew Long asked whether or not to <<repeat information
 that is the same for each flavor [of four GUI flavors] in
 every section, or should I write it once and make reference
 to it in the other sections.>>

 Assuming that I understand the "flavors" you're discussing:
 One good solution might be to write the identical sections
 only once, then combine _all_ sections (including the
 unique ones) into an alphabetical reference. Then, on the
 first page of the manual, show four screenshots, with a
 title (e.g., "management version", "editor version", or
 whatever). For each screenshot, do a callout for the
 important points (i.e., insert an arrow pointing to the
 interface feature, with the name of the feature and a page
 reference at the end of the arrow).

 This way, readers can immediately see which version they're
 using, glance at the feature they don't understand, flip to
 the correct page, and get the info. immediately. (You could
 use the same procedure in online help.)

 The only big problem, which may not be a problem at all, is
 that you haven't specified the nature of the differences in
 the four flavors, so I'm really guessing at what you mean.
 If it's just a question of different text and buttons, then
 my suggestion should work fine. If they use a whole
 different metaphor or approach (e.g., Mac vs. Windows vs.
 DOS versions; batch-processing vs. interactive response;
 etc.), then you should probably add a single small chapter
 for each flavor that defines the approach used by that
 flavor. Then put in cross-references to the appropriate
 entries in the alphabetical reference listing.

 This is a "build your own solution" suggestion, because I
 don't have enough details on your problem to understand the
 differences between flavors. But it should provide a
 helpful pointer in the right direction.

 --Geoff Hart     @8^{)}     geoff-h -at- mtl -dot- feric -dot- ca
 Disclaimer: Speaking for myself, not FERIC.

 TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot-  Send commands
   to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
  Search the archives at http://www.documentation.com/  or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html