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.
>>Is it proper to refer a reader to a chapter that is later in the manual?
Yes, that's fine. In fact its more than fine. Its super-snorky.
In these days of hypertext, it's proper to refer a reader anywhere the content is.
And it's also important that you do not duplicate content because it increases the chance of mistakes and makes localization (more to translate), production (more page breaks to doublecheck), editing (more to edit), and printing costs (more pages) higher.
So, once you fix this, you can put the following on your resume:
"Dramatically reduced costs of translation, production, and printing for documentation department."
Matthew J. Horn
Sr. Technical Writer
< m a c r o m e d i a >
From: Evan Martin [mailto:evan -dot- martin -at- garvin-allen -dot- com]
Sent: jeudi 19 septembre 2002 15:41
Subject: References a later chapter
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 to
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
Enhance, optimize and automate your FrameMaker-to-PDF workflow with TimeSavers:
Define all PDF features in your source FrameMaker files ONCE, distill MANY.
Bookmark Controller, Link Controller, UnBloat & more : http://www.microtype.com
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.