documenting multiple editions of software

Subject: documenting multiple editions of software
From: "Andy Crawford" <andy -at- crawford -dot- net>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 12 Jul 2001 18:12:04 -0500

Mary Reynolds wrote:
>For the first time, I'm documenting a software product that has both a
>standard edition and an enterprise edition, which is basically standard
plus
>additional functionality. I'd like to find out which is the more common
>practice: to document each edition separately, or document the standard
>edition and add sections about enterprise functionality where needed.

Mary, I recommend using FrameMaker's conditional text features. The
investment is worth it if you don't already have FM. I completed a similar
project recently, and inserting conditional text and outputting two separate
versions from a single-source saves you from double document maintenance. It
makes it easier to insert the releveant Enterprise version content in the
correct sections, rather than tacking on separate sections.



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

*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available now at http://www.devahelp.com or info -at- devahelp -dot- com

TECH*COMM 2001 Conference, July 15-18 in Washington, DC
The Help Technology Conference, August 21-24 in Boston, MA
Details and online registration at http://www.SolutionsEvents.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.


Previous by Author: Re: Software solution
Next by Author: RE: Medical writing?
Previous by Thread: Re: documenting multiple editions of software
Next by Thread: Pronouns with User?


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


Sponsored Ads