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.
Your primary concern should be how will the user use your pub and how will
the organization of your pub affect its usefulness. I don't know of any
standards that require parts, sections, chapters, headings, lead-ins or what
have you. If the manual you are writing can be most effectively organized
without divisions, then by all means use that organization. If, and this is
normally the case, divisions in your manual will make it easier for the user
to understand (and thus increase its usefulness) then use divisions.
In this situation, where your projecting 75 pages or more, I don't see how
you can organize the manual without using chapters or sections. The rule of
thumb for this one is the application of pure common sense.
Good Luck
Paul C.
paul -dot- cheverie -at- gpo -dot- canada -dot- cdev -dot- com
----------
From: TECHWR-L
To: Multiple recipients of list TECHWR-L
Subject: ARE SECTIONS/CHAPTERS ALWAYS NEEDED?
Date: Tuesday, July 16, 1996 10:17AM
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-
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-
