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.
>
> "Here's the User Guide, with everything in it, but here
> are also several of the chapters, separated out, with
> frontmatter (title pages, boiler-plate, ToCs, etc.) added,
> and each with its own Bill of Materials number that must be
> tracked, and each with the same content (if the techwriter
> did his job) as the chapters, but needing to be separately
> reviewed by our PV/QC people, and the extra costs passed on
> to you, and together they make a jumble of files on the CD,
> so we had to create a map to help you navigate them all, and
> the extra cost passed on to you"...? Like that, you mean?
>
> <gdrh>
Yeah, like that. I think you laid out the "map" in your original post:
>>Assume that the User Guide has a big chapter on Integration
instructions for using our stuff with various third-party
applications, but you use the relevant portion of that
chapter one time, and then never look at it again...
/>>
>>unlike the rest of the User Guide that is usefully kept as a
reference.
/>>
>>If you've bought the SDK to do your own
development, then you don't ever refer to the "canned"
integration instructions
/>>
+ Release Notes
+ Install Guide
+ Setup Guide
But, if this is on CD, and not online, there's no problem in putting the
User Guide info (including integration & Setup Guide into the User Guide).
I'd keep the Release Notes & Install Guide separate, but also repeat the
Install in the User Guide (perhaps as an Appendix.).
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Last chance to order RoboHelp X3 and receive a $100 mail-in rebate,
PLUS free RoboScreenCapture and WebHelp Merge Module. Offer expires
4/30/03! Order here: http://www.ehelp.com/techwr-l
Help celebrate TECHWR-L's 10th Anniversary starting this month!
Check out the contests at http://www.raycomm.com/techwhirl/special/contests/
Happy birthday to you, happy birthday to you, happy birthday TECHWR-L....
---
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.
