Indenting results [WAS: Question for Tech Writers' List]

Subject: Indenting results [WAS: Question for Tech Writers' List]
From: Chris Knight <knight -at- ADA -dot- COM>
Date: Wed, 6 May 1998 17:26:35 -0700

I strongly disagree with Dick Margulis' solution. I think it is wordy
and, because reders scan for the procedure heading they are interested,
it risks the user missing important steps. The result statement should
line up below the step that caused it, even if you consider it to be the
result of the whole procedure.

And there is nothing wrong which nested procedures, as long as they are
well (i.e. concisely) written and formatted properly.

Chris Knight
Consultant, Technical Communication Architect
Vancouver BC, Canada
(currently at Applied Digital Access,
E-mail: knight -at- bcg -dot- ada -dot- com Phone: 604-415-5886 Fax: 604-415-5900)
Opinions expressed are my own, not ADA's

Previous by Author: Non-technical, Technical Writers
Next by Author: Re: grammar survey - recap
Previous by Thread: Re: Organization of User's Guide
Next by Thread: Using MS Word for Large Documents: Some Solutions

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

Sponsored Ads

Sponsored Ads