RE: More help needed

["Hager, Harry (US - East Brunswick)" <hhager -at- dc -dot- com>]

Sharon,

It depends on the requirements of the application you are documenting and
the requirements of your readers. In a vacuum, there is no "best" method.
I've used both methods.

However, here are some things to consider:

1. Is time a factor? 

It will take less time to construct a table (Field Name, Description,
Format) and use the same format for every screen than it will to go through
each step for each screen.

2. Is there a required sequence of steps or can the user enter info into the
fields in more or less any order?

If there is a required sequence, the step by step approach is probably
better.

3. How many fields are there on a screen?

If there are say about 20 (pick a number, any number, greater than about 15)
or more fields, the step by step approach will be very long, spreading over
lots of pages of similar looking text and the reader will easily get lost.
Readers really hate to be confused when reading step by step instructions.
In this case the table might be better.

4. How much information needs to be stated for each field?

If most of the fields are more or less self explanatory (Last Name, ID
Number, etc) where only a paragraph or two is needed to fully inform the
reader, the table might be better. However, if you  are explaining the
theory of relativity as you discuss the fields, with lots of supporting text
needed, then the step by step approach is probably better. 

5. Do you and your readers want/need/demand conciseness or thoroughness? 

Table for conciseness; step by step for thoroughness.

Now put all these considerations into the mix, add some common sense, stir a
little, and you and your boss will probably come to the same position
(unless one of you is just stubborn.) 

Good Luck and let us know what you and your boss decide.

Jim Hager
hhager -at- dc -dot- com





---------- Original Message -------

Subject: More help needed
From: Sharon Deitch <sharon -at- sintecmedia -dot- com>
Date: Mon, 2 Oct 2000 11:52:49 +0200
X-Message-Number: 2

Hi everyone,

Again I come to you with questions.  First let me thank everyone who sent
their ideas to me regarding screen terminology.

When documenting data records, which of the following would you find
preferable:

+  Listing all the fields in a table, including whether the field is
required and what to fill in the field (also what type of data can be input,
where appropriate).

+  Numbered steps that take the user through the data screen, including all
of the above information.

I prefer one method, and my boss the other.  I'm purposely not saying which
I prefer, so as not to skew the results.  He's asked me to find out from you
good people which is considered the "acceptable" way.

Thanks muchly,

Shalom from Jerusalem,
Sharon

Sharon Deitch
Technical Writer
SintecMedia
sharon -at- sintecmedia -dot- com


This message (including any attachments) contains confidential information
intended for a specific individual and purpose, and is protected by law.  If
you are not the intended recipient, you should delete this message.  Any
disclosure, copying, or distribution of this message, or the taking of any
action based on it, is strictly prohibited.