TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Organizing single user guide for multiple editions of software
Subject:Organizing single user guide for multiple editions of software From:"Jennifer Westerberg" <jen -at- kurant -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 15 Aug 2001 12:20:51 -0700
Hello -
I'm in the process of overhauling a user guide, and I'm looking for some
input.
The software being documented can be purchased in either the "standard"
edition or the "professional" edition (the professional edition containing
more features). For several reasons, the user guide needs to contain
information and instructions for both editions.
Presently, the instructions for professional features are incorporated into
the guide with the standard edition features, with a notation that "XXX is
available in Professional Editions only".
My concern though is that when someone upgrades from standard to
professional, these instructions will be hard to find - I hate the thought
of the user having to reread the whole thing, just looking for those
notations. I've thought of adding an "When You Upgrade" appendix that lists
the new features (which the reader can then read about further in the
guide), or moving all the professional features instructions into a total
separate chapter/section.
Has anyone else dealt with this situation? Do you have any suggestions for
ways of organizing the content? Any ideas or issues I should be
considering?
Thanks,
Jennifer Westerberg
Kurant Corporation
jen -at- kurant -dot- com
*** 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
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/
---
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.
