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: User Guide - best practices From:Erika Yanovich <ERIKA_y -at- Rad -dot- co -dot- il> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Sun, 28 Jul 2002 14:40:41 +0300
Lisa,
As lots of people on this list will tell you: it depends. But here we are
facing a similar situation. One of our SW manuals became so large that we
had to split it into two 8-cm wide binders. And this is before it even
contains any tasks - we want to add these too. The solution we came up with
is having the tasks in the main body of the manual, while the screen
"dictionary" will be moved to the end - for reference. Additionally, we will
write a documentation plan to map tasks to publications (user doc, help,
installation guide, etc.), so some tasks might move from the large user doc
to another pub.
Erika
____________________________________________________________
Carriers and Service Providers!
Offer Leased Line Services over ATM with RAD's Integrated Access Devices. http://www.rad.com/appnotes/la_frm.htm
_____________________________________________________________
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Your monthly sponsorship message here reaches more than
5000 technical writers, providing 2,500,000+ monthly impressions.
Contact Eric (ejray -at- raycomm -dot- com) for details and availability.
Buy RoboHelp Deluxe starting at only $798: you'll get RoboDemo, the hot new
software demonstration tool that's taking the Help authoring world by storm,
together with RoboHelp Office. Learn more at 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.
