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.
Subject:Re: [Fwd: Question for Tech Writers' List] From:Dick Margulis <ampersandvirgule -at- WORLDNET -dot- ATT -dot- NET> Date:Wed, 6 May 1998 19:51:29 -0400
Lucille,
Thanks for reposting it legibly. The answer is neither. Try it this way
(intentionally flattening the structure of nested procedures):
To install the doohickey:
1. Grimbulate the fisteris[sp?].
2. Connect the fisteris to the doohickey.
3. Initialize the doohickey.
To grimbulate the fisteris:
1. Xxxxxxxxxxxxx.
2. Yyyyyyyy.
3. Zzzzzzzzz.
The doohickey is now ready for the next procedure.
To connect the fisteris to the doohickey:
1. Aaaaaa.
2. Bbbbbbbbbbb.
The doohickey is now ready to be initialized.
To initialize the doohickey:
1. Plug it in.
2. Turn it on.
3. Run like hell.
The doohickey is now installed.
Lucille Lattanzi wrote:
>
> This is a multi-part message in MIME format.
> --------------7145B539EFEA1D0B93B25C35
> Content-Type: text/plain; charset=us-ascii
> Content-Transfer-Encoding: 7bit
>
> My second try. I will try to send this text only.
> Sorry for the garbage message.
> Lucille
>
> --------------7145B539EFEA1D0B93B25C35
> Content-Type: message/rfc822
> Content-Transfer-Encoding: 7bit
> Content-Disposition: inline
>
> Return-Path: <susan -dot- peradze -at- peri -dot- com>
> Received: from peri.com by mailroom.peri.com (SMI-8.6/SMI-SVR4)
> id QAA00903; Wed, 6 May 1998 16:28:57 -0400
> Received: from peri.com (pc290i) by peri.com (5.x/SMI-SVR4)
> id AA25877; Wed, 6 May 1998 16:28:52 -0400
> Message-Id: <3550C6FD -dot- 2B8ED33B -at- peri -dot- com>
> Date: Wed, 06 May 1998 16:24:29 -0400
> From: susan peradze <susan -dot- peradze -at- peri -dot- com>
> X-Mailer: Mozilla 4.04 [en] (WinNT; I)
> Mime-Version: 1.0
> To: llattan -at- peri -dot- com
> Subject: Question for Tech Writers' List
> Content-Type: text/plain; charset=us-ascii
> Content-Transfer-Encoding: 7bit
>
> Hi Lucille-
> I would like to know if there is a rule regarding the following, or if
> not, what standard practice have other writers encountered:
>
> WHEN WRITING A PROCEDURAL LIST (WHICH MAY OR MAY NOT CONTAIN PROCEDURES
> WITHIN PROCEDURES) DO YOU INDENT THE RESULT OF A SPECIFIC STEP TO LINE
> UP WITH THE TEXT OF THAT STEP(EXAMPLE A)? IF THE RESULT COMES FROM THE
> CUMULATIVE ACTIONS OF ALL OF THE PRECEDING STEPS, DO YOU THEN LINE UP
> THE TEXT OF THE RESULT WITH THE NUMBERS OF THE PRECEDING STEPS (EXAMPLE
> B)?
>
> EXAMPLE A
> 1. XXXXXXXXXXXX
> 2. XXXXXXXXXXXX
> 3. XXXXXXXXXXXX
> XXXXXXXXXXXX (RESULT OF STEP 3)
>
> EXAMPLE B
> 1. XXXXXXXXXXXX
> 2. XXXXXXXXXXXX
> 3. XXXXXXXXXXXX
>
> Thanks for sending this out for comment.
> XXXXXXXXXXXXXXXXXXXX (RESULT OF STEPS 1,2, AND 3)
>
> --------------7145B539EFEA1D0B93B25C35--
>