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: What to call an umbrella document? From:APEERY -at- FAMILYDOLLAR -dot- COM To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Thu, 31 May 2001 10:00:37 -0400
Will the existing installation guides and the new document, together, cover
all end-user aspects of the product? If so, I would vote for "[product]
User Guide" as the name of the new document. It would be a complete User
Guide, with the installation bits broken out by component, and referenced by
links in the new document.
OTOH, if the new document will concern mainly installation issues, how about
"[product] Installation Overview," or even "[product] Installation
Procedures"?
> -----Original Message-----
> From: Becca Price [SMTP:becca_price -at- yahoo -dot- com]
> Sent: Wednesday, May 30, 2001 4:51 PM
> To: TECHWR-L
> Subject: What to call an umbrella document?
>
> We have a very elaborate product, which consists of a number of
> components that can be installed in any number of
> configurations. Because of this, we have a separate
> installation guide for each component. Unfortunately, there
> really isn't any one place to put information that relates to
> the product as a whole, or talk about interactions between
> different components, installation order, and so forth.
>
> There actually exist documents that (mostly) contain this
> high-level information - three of them, with a whole lot of
> overlap. They are called "Getting Started Guides" - which in
> itself causes confusion, because experienced installers don't
> look at them, because the name implies something different
> (IMHO) from what they are.
>
> My task is to take these three documents and blend them into one
> overall, umbrella document that would point to the individual
> installation guides for details that pertain to each component.
>
> What I don't know is what I should call this umbrella document.
*** 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
Sponsored by Information Mapping, Inc., a professional services firm
specializing in Knowledge Management and e-content solutions. See http://www.infomap.com or 800-463-6627 for more about our solutions.
---
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.
