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.
I am working on a project that involves documentation for a
production scheduling system. The internal clients want the
documentation short and sweet.
We have decided to document by task and not by system function.
However, tasks seem to be harder to group for this project. No
significant number of tasks seem to be related enough to put into
sections or chapters. For instance, I would normally group
things like adding, changing and deleting in an "Editing"
section.
My questions to the list:
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.
The scope of project looks like it could turn out to be 75 or
more pages (run front and back).
-- Barb --
bridley -at- usccmail -dot- bms -dot- com
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-
