RE: Is there such a thing as TMI?

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
> more
> 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?)

=====
John Posada, Senior Technical Writer
Current gig ending 4/15
Resume: http://www.tdandw.com/Resume_Posada_022202.doc
mailto:john -at- tdandw -dot- com, 732-259-2874

__________________________________________________
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.



References:
RE: Is there such a thing as TMI?: From: jgarison

Previous by Author: re: on technical writing
Next by Author: Re: sorry
Previous by Thread: RE: Is there such a thing as TMI?
Next by Thread: RE: Is there such a thing as TMI?


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads