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: One Doc or Multiple Docs? From:Michele Davis <michele -at- krautgrrl -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Thu, 02 Nov 2000 09:50:00 -0600
Please post answers to the list, or cc me. I'm dealing with a similiar issue. I
had a prospective client ask me yesterday:
"How would you address five different audiences in one manual, and one online
The software product is for graphic designers, and web developers, some people
will be running Linux, and some Win2000, and they want to combine all the
information in 1 manual. Oy guvalt!
My manual would have the same 5 chapters as Dawson, except there would be an
additional chapter on UI navigation for the neo-phobes. In addition, I'd be
addressing two operating systems.
Dawson McKnight wrote:
> How "consolidated" is your documentation set? Do you provide installation,
> administration, configuration, and troubleshooting guidance in a single
> document (e.g., an "Administrator's Guide"), or do you provide each of these
> kinds of instructions in a different document? Without a substantial user
> base, how can I determine how consolidated my documentation set should be?
> Here is how our documentation looks now:
> * Installation guide
> * Overview: Describes the product's architecture, functions, and features
> * Administration guide: Setting up security policies using an
> administration GUI (e.g., creating users, determining what they should have
> access to, etc.)
> * Configuration guide: Configuring the various components (servers) to
> communicate with each other in a distributed environment
> * Troubleshooting guide
Sponsored by SOLUTIONS, Conferences and Seminars for Communicators
Publications Management Clinic, TECH*COMM 2001 Conference, and more http://www.SolutionsEvents.com or 800-448-4230
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.