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: Help with Manual Organization From:Liz_Vela -at- bcbstx -dot- com To:"Stacy Jackson" <Stacy -dot- Jackson -at- choicepoint -dot- com> Date:Fri, 12 Jan 2007 12:02:48 -0600
I would divide the content into three manuals. Some users may not need
either the setup or plugin manuals. Others may need only two of the
manuals. Since you're expecting a lot of growth, you may as well prepare
for it. I would not put the plugin content into two manuals. Maintenance
could become a problem.
Liz
"Stacy Jackson"
<Stacy -dot- Jackson -at- ch
oicepoint.com> To
Sent by: techwr-l -at- lists -dot- techwr-l -dot- com
techwr-l-bounces+ cc
liz_vela=bcbstx.c
om -at- lists -dot- techwr-l Subject
.com Help with Manual Organization
01/10/2007 04:42
PM
I support a software product that has basic functionality and several
plug-in options. Currently, there are five plug-ins with more on the
way. I've been told we could have as many as 15 or 20 different plug-in
options eventually. Let me emphasize that these plug-ins are optional. A
very limited number of clients will have all of them. Many customers may
have one plug-in. Some may have a couple. Some may have none of the
plug-ins.
For the existing product and five plug-ins, we have an installation
manual and a user manual that includes setup information. The user
manual about 400 pages long and has a PDF size of 10 MB. I would like to
divide the manual to make it/them a smaller size both by number of pages
and file size.
The division options seem to be:
1. Separate the setup and user information and keep the plug-in
information embedded in each document.
Advantages: Only three manuals to maintain; users have only three
manuals to find information in; this is a common division of information
among software manuals; promotes plug-in products by putting them in
front of the clients whether they want to see them or not.
Disadvantages: User must contend with plug-in product information that
doesn't apply to them; documents still may become so large that future
removal of plug-in information is necessary later; there is no one place
to go to see everything about a plug-in.
2. Separate out the plug-in information and keep the setup and
user
information together in the same manual.
Advantages: Once plug-in "guides" are created, they will need little
maintenance because unlike main product, they probably won't change
much; clients won't have to see information that does not apply to them;
if this information will eventually be separated out, it's easier to
remove now; guides could be used during Sales process to demonstrate the
plug-in functionality.
Disadvantages: Clients will have more places to look for information;
may disturb flow of instructions in main manual - to complete steps must
refer to separate guide.
I've done an informal survey here at work and the preferences are split
right down the middle.
Anything other things I should consider? Any strong feelings about which
would be a better division?
And any sage advice would be greatly appreciated!
Thank you,
Stacy
Lead Documentation Specialist
stacy -dot- jackson -at- choicepoint -dot- com
This message (and any associated files) is intended only for the
use of the individual or entity to which it is addressed and may
contain information that is confidential, subject to copyright or
constitutes a trade secret. If you are not the intended recipient
you are hereby notified that any dissemination, copying or
distribution of this message, or files associated with this message,
is strictly prohibited. If you have received this message in error,
please notify us immediately by replying to the message and deleting
it from your computer. Messages sent to and from us may be monitored.
Internet communications cannot be guaranteed to be secure or error-free
as information could be intercepted, corrupted, lost, destroyed, arrive
late or incomplete, or contain viruses. Therefore, we do not accept
responsibility for any errors or omissions that are present in this
message, or any attachment, that have arisen as a result of e-mail
transmission. If verification is required, please request a hard-copy
version. Any views or opinions presented are solely those of the author
and do not necessarily represent those of the company.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include single source authoring, team
authoring,
Web-based technology, and PDF output. http://www.DocToHelp.com/TechwrlList
---
You are currently subscribed to TECHWR-L as Liz_Vela -at- bcbstx -dot- com -dot-
To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com
Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit http://www.techwr-l.com/techwhirl/ for more resources and info.
**********
The information contained in this communication is confidential, private, proprietary, or otherwise privileged and is intended only for the use of the addressee. Unauthorized use, disclosure, distribution or copying is strictly prohibited and may be unlawful. If you have received this communication in error, please notify the sender immediately at (312)653-6000 in Illinois; (800)835-8699 in New Mexico; (918)560-3500 in Oklahoma; or (972)766-6900 in Texas.
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
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include single source authoring, team authoring,
Web-based technology, and PDF output. http://www.DocToHelp.com/TechwrlList
---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-
