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.
Subject:RE: Planning modular help for software packages From:Paul Hanson <PHanson -at- Quintrex -dot- com> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Fri, 24 Feb 2006 10:36:35 -0600
You have a lot of work ahead of you and I wish the best of luck in figuring
it all out. One of the things that threw up a red flag in my mind is to
bring up the situation where your documentation already has link(s) to the
doc for a package the client may not have installed. For example, if your
client only has Packages A & B, but you have a link from B to C in the doc,
you either have to not give them the information in package C by rewriting
the content to not refer to package B <which if that connection exists, that
makes your doc incomplete> or give them the doc for package C. I document a
system that has many of these cross-system links
<http://www.quintrex.com/Products/Grid_prod3_small.htm> so I don't think I
could do what you are suggesting. I give our clients all the doc.
Paul Hanson
Technical Writer
Team Macromedia - RoboHelp http://www.macromedia.com/support/forums/team_macromedia/team_members/200.ht
ml
Quintrex Data Systems http://www.quintrex.com
email: phanson at quintrex.com
-----Original Message-----
From: techwr-l-bounces+phanson=quintrex -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+phanson=quintrex -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf
Of Fugalli, Claudia
Sent: Friday, February 24, 2006 10:14 AM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Planning modular help for software packages
<snip>
2) I would like the structure of the help file to mimic the structure of the
product, so that if a customer didn't buy Package B then the help for
package B and its related plug-ins will be excluded from the help file.
(note that i only want to do this at the package level, not for plug-ins --
people pay extra for those, and i'm hoping that the help content can help
sell them ;-).
<snip>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today!. http://www.webworks.com/techwr-l