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:What to call an umbrella document? From:Becca Price <becca_price -at- yahoo -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 30 May 2001 13:50:42 -0700 (PDT)
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.
it's not exactly a unified installation guide - we still have to
keep the individual ones for obvious reasons. I'd kinda like to
get away from "getting started" because it also contains upgrade
information, but there is historical inertia behind keeping the
"Getting Started" title.
What do you think a "Getting Started" document is? And can you
suggest a better name for my umbrella document?
There's no such thing as useless information, only information for which you haven't found a use yet.
__________________________________________________
Do You Yahoo!?
Get personalized email addresses from Yahoo! Mail - only $35
a year! http://personal.mail.yahoo.com/
*** 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.
