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: Is there such a thing as TMI? From:John Posada <jposada01 -at- yahoo -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 19 Mar 2002 11:12:37 -0800 (PST)
> In our help system, we layer information so that people who want
> information can dig deeper and find it. People who are looking for
> just the basics can find them too.
This model might give you some ideas. This is for a documentation
collecgtion that the user can access from the web as PDFs:
I have applications where a single document describes how to use the
core application. However, to successfuly run the application, there
are things you must do prior to launching it, and things you must do
with the output of the application.
In the beginning of the document, in a sectionon the first page, I
include links to PDFs of all the things they must do before and
after. Then, when ther user is going from step to step, if there is
any document that relates to that step, I include a link called
"Additional documentatation: How to yada, yada, yada"
The links in the beginning for if the user wants to assemble the
suite of documents prior to using it to learn it "soup to nuts"
before launchiung it, and the links at the steps for those who find
themself at a point and don't know what to do....("just-in-time" instruction?)
Do You Yahoo!?
Yahoo! Sports - live college hoops coverage http://sports.yahoo.com/
PC Magazine gives RoboHelp Office 2002 five stars - a perfect score!
"The ultimate developer's tool for designing help systems. A product
no professional help designer should be without." Check out RoboHelp at http://www.ehelp.com/techwr
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.