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: punctuation and procedure titles... From:"Terry Barron" <tbarron -at- systems -dot- dhl -dot- com> To:Angela Pollak <angela -dot- pollak -at- sybase -dot- com> Date:Thu, 09 Mar 2000 11:41:38 -0800
This is from Sun Technical Publications, _A Style Guide for the
Computer Industry_
"Unlike lists, steps *always* should be complete sentences.
- Use sentence-style capitalization.
- End the sentence with appropriate punctuation."
~~~ Terry
Angela Pollak wrote:
>
> Do you punctuate procedural titles with a colon? For example, which of the
> following would you say is correct:
>
> To <fry an egg>:
> 1. blah blah.
> 2. blah blah blah.
>
> To <fry an egg>
> 1. blah blah.
> 2. blah blah blah.
>
> And what is your reasoning?
>
> My apologies if this has been discussed before... I've exhausted my
> resources on the subject matter and they are anything but conclusive.
> Roughly half said it is correct, and the other half said it is incorrect.
> Some based the decision on opinion, some on snippets of grammar rules that
> may or may not be relevant to the field of software documentation. I even
> asked two grammarians and they both came up with opposite answers. Oops.
>
> I'm no further ahead than when I started looking into the subject :-}
>
> Thanks
>
> ~A~
>
