From: Kat Nagel/MasterWork <katnagel -at- EZNET -dot- NET>
Date: Tue, 16 Jul 1996 13:43:23 -0400

Barb Ridley asked:
> Are sections and chapters always needed, or should I just put
> tasks as main headings?

> Is it enough to just list the tasks in a table of contents and
> have one long continuous piece of documentation.

As a user, I prefer some kind of organization, not just a list of tasks.
Ideally, the system itself will impose some logical order to the tasks:

Setup (task set)
Normal operation 1 (task set)
Normal operation 2 (task set)
Shutdown (task set)
Maintenance (task set)
Troubleshooting (task set)

or (possibility for production scheduling software)

Installation (task set)
Scheduling for a single product or machine (task set)
Scheduling for multiple units (task set)
Error codes and troubleshooting (task set)
Printing reports and summaries (task set)

Can you talk to the folks who will actually do the scheduling using your
product? If so, ask them what groupings seem logical to them, what
processes naturally flow into others.

@Kat _______________________________ katnagel -at- eznet -dot- net
Kat Nagel MasterWork Consulting Services, Rochester, NY
Technical writing / Editing / Document design

"The danger of technology is that it demands to be fed."
Sherry Turkle (cyberpsychologist), in _Life in the screen_

TECHWR-L List Information
To send a message about technical communication to 2500+ list readers,
E-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send administrative commands
ALL other questions or problems concerning the list
should go to the listowner, Eric Ray, at ejray -at- ionet -dot- net -dot-

Previous by Author: Re: Conferences and Seminars
Next by Author: TOOLS surplus monitors
Previous by Thread: Finding Software Programs
Next by Thread: QUERY: Long vs. Short Manuals

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

Sponsored Ads