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:Standard Docset for Hardware/Software Products? From:Heidi <hvonmarkham -at- gmail -dot- com> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Mon, 12 Jun 2006 10:45:05 -0700
I'm getting feedback (via the Tech Marketing department) that our docset has
too many docs and that customers want all the information in one or two
docs. The current docset includes what I thought was the standard minimal
set of four docs: user guide, release notes, quick start guide (covers
hardware install and logging into the UI), and a safety guide (provides
specification on the hardware itself).
First question is: What is everyone else using as the standard "minimum" set
of docs for a combo hardware/software product?
Second question is: If you had to combine any of the four docs mentioned
above, how would you do it? For example, does anyone combine the hardware
safety info with the quick start (or getting started) info? Or maybe the
release notes with the quick start?
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
Doc-To-Help includes a one-click RoboHelp project converter. It's that easy. Watch the demo at http://www.DocToHelp.com/TechwrlList