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