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.
> Here's a question that I think I know the answer to. But because I'm new,
> I'm hoping I'm wrong.
> Is it proper to refer a reader to a chapter that is later in the manual? I
> want to avoid duplicating a section that is later in the manual (and has
> stay there).
I see nothing wrong with a reference to a later chapter. It's not a novel -
you're not giving anything away. ("For additional information on Rosebud,
see the glossary under 'Sleds.'")
Whether it's appropriate in a given situation is the question only you can
answer, based on what exactly you're discussing in the manual. If the
reference is to a critical part of a long set of instructions, duplicating a
section is reasonable. In fact, it's expected. You don't want the reader
shifting back and forth between ten different chapters to complete a basic
But if it's a cross-reference for information purposes ("for detailed
information about Code Tables see page 135"), by all means cross-reference.
If you're unsure, pretend you're the User trying to complete a task. Ask
yourself why you need a cross-reference to begin with. Would you want the
information on the same page, or would you prefer to leaf through the manual
to find it because it would just clutter up the manual?
Windsor Technologies, Inc.
2569 Park Lane, Suite 200
Lafayette, Colorado 80026
E-mail: paul -dot- strasser -at- windsor-tech -dot- com
FrameMaker-to-PDF TimeSavers Assistants let you enhance & automate navigation
in PDF doc sets (chapter tabs, next/prev chapter/pg, bookmarks, popup menus);
create interactive PDF forms, rollover popups; presentations: http://www.microtype.com
Experience RoboHelp X3! This new RoboHelp release combines single sourcing,
print-quality documentation, conditional text and much more, into the most
monumental release of RoboHelp ever! http://www.ehelp.com/techwr-l
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.