Re: lists and explanations

Subject: Re: lists and explanations
From: John Posada <jposada01 -at- YAHOO -dot- COM>
Date: Thu, 29 Apr 1999 09:52:59 -0700

As we speak, I'm creating a section of a manual for
running reports.

I prefer the drill-down method per the following
outline:

In the following outline:
Feature is Reports,
Options are 3 Tabs,
Variations are configuration settings on each tab,
Use of Variations is real-life situations

By the time they are done with a Feature, they should
know what it is for, what configurations can be used,
and how to apply them in real life.


Reports
How to use the Reports
Overview

Option 1 of Reports
Use of Option1
Variation 1 for Option1
Use of Variation1
Variation 2 for Option1
Use of Variation2
Variation 3 for Option1
Use of Variation3

Option 2 of Reports
Use of Option2
Variation 1 for Option2
Use of Variation1
Variation 2 for Option2
Use of Variation2
Variation 3 for Option2
Use of Variation3

This may be clearer in real life, but I think you get
the idea. I avoid having people jump around between
sections.

> I'm explaining how to perform a series of steps for
> a procedure and
> have to give more information on a particular point.
> For example: "Select the document type from the
> drop-down list. There
> are five different document types..."
>
> So, do you think I should give it after the step in
> question, or refer
> them to another part of the document, where I've
> given an explanation? I
> don't want to break up the sequence of steps, but at
> the same time, I
> don't want them to be looking all over for the
> explanation.
>
> What do ye think?
>
> Thanks,
>
> Aoidin
>

===
John Posada
Western Union International
(w) jposada -at- westernunion -dot- com
(p) john -at- tdandw -dot- com
_________________________________________________________
Do You Yahoo!?
Get your free @yahoo.com address at http://mail.yahoo.com

From ??? -at- ??? Sun Jan 00 00:00:00 0000=




Previous by Author: Re: What makes a technical writer
Next by Author: Re: FWD: Too good to be true?
Previous by Thread: Re: Lists and Explanations
Next by Thread: Re: lists and explanations


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


Sponsored Ads