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.
Krista van Laan <vanlaan -at- BILBO -dot- NTC -dot- NOKIA -dot- COM> wrote:
>I'm concerned that the procedures will be much too long. I >really dislike seeing 20- or 30-step procedures.
Why don't you try this:
1.) Give the long procedure a 1st level heading.
2.) Break down the long procedures into three or four smaller ones. Give
each of the smaller procedures a 2nd level headings.
3.) Below the first level heading, explain that the long procedure
consists of sub-procedures a, b, c, and d.
4.) Introduce sub-procedures by explaining where they fit into the
longer procedures.
5.) At the end of each sub-procedure, remind readers what sub-procedure
they have just finished, how it fits into the longer procedure, and what
the next sub-procedure is.
The result takes up more space than one long procedure, but should be
less intimidating.
