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: Print vs Online versions of same manual From:"John Posada" <JPosada -at- isogon -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 24 Mar 2004 18:06:58 -0500
I compromise on this.
I mark the procedure topics to appear in the help's TOC and mark the
conceptual to not appear, However, since it is often important to
explain the concept behind steps in the procedure, I include links in
the procedures to the conceptual material to assist in the understanding
of the concepts.
Senior Technical Writer
Isogon Corporation http://www.isogon.com
"Realizing Your Business Goals
Through Software Asset Management"
From: bounce-techwr-l-143723 -at- lists -dot- raycomm -dot- com
[mailto:bounce-techwr-l-143723 -at- lists -dot- raycomm -dot- com] On Behalf Of
Sent: Wednesday, March 24, 2004 6:00 PM
Subject: RE: Print vs Online versions of same manual
>Why do you strip the conceptual information out of the online help?
Let me rephrase that: we strip the *excess* conceptual information out
of the help. The help system is focused on tasks rather than theory, and
our intent is to help users find what they need to finish their tasks
quickly. The conceptual info in its totality is included in the user
guide, which can be launched from the footer of each topic.
ROBOHELP X5 - ALL NEW VERSION. Now with Word 2003 support, Content
Management, Multi-Author support, PDF and XML support and much more!
Now is the best time to buy - special end of month promos, including:
$100 mail-in rebate; Free online orientation on content management
functionality; Huge savings on support and future product releases;
PLUS Great discounts on RoboHelp training. OFFER EXPIRES March 31!
Call 1-800-358-9370 or visit: http://www.ehelp.com/techwr-l
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -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.