Re: Colons versus periods in procedures containing illustrations

Subject: Re: Colons versus periods in procedures containing illustrations
From: "Peter Neilson" <neilson -at- windstream -dot- net>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Tue, 27 Nov 2018 03:53:39 -0500

My techy brain's preference is for the colon. That very fact suggests that the period is a better choice.

But who will care? Only other tech writers.

Oh, also SMEs whose priorities are out of whack! If any SME suggests that you have a problem with punctuation, that person's technical review probably overlooks substantial technical matters.

If a PHB asks you to change punctuation, and there is no serious consequence to the grammar or meaning, do it. It will make his pointy hairs happy.

On Mon, 26 Nov 2018 23:25:12 -0500, Lin Sims <ljsims -dot- ml -at- gmail -dot- com> wrote:

So far the consensus seems to be using the period. Now, is there a style
guide that actually SPECIFIES this, or do I just rely on "this is a full
complete sentence"?

On Mon, Nov 26, 2018 at 11:08 PM Grant Hogarth <grant -at- hedgewizard -dot- net>
wrote:

I would use the period. You are making a declarative statement that is
illustrated by the image.

Grant
On Nov 26, 2018, at 2:34 PM, Lin Sims <ljsims.ml <%3Ca>@gmail.com
target=_blank>ljsims -dot- ml -at- gmail -dot- com> wrote:

It's a niggly thing, but I cannot find a style guide that addresses the
topic.

Say you have a step in a procedure, and the step contains a graphic
illustration after the text.

Do you end the text part of the step with a period or a colon, and why?

Should it be:

1. Click Configure:
[graphic here]

OR

1. Click Configure.
[graphic here]


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | https://techwhirl.com

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com


Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwhirl.com/email-discussion-groups/ for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives


References:
Colons versus periods in procedures containing illustrations: From: Lin Sims
Re: Colons versus periods in procedures containing illustrations: From: Grant Hogarth
Re: Colons versus periods in procedures containing illustrations: From: Lin Sims

Previous by Author: Re: Transitioning to Scrum/Kanban
Next by Author: Re: Visio Guy site down?
Previous by Thread: Re: Colons versus periods in procedures containing illustrations
Next by Thread: RE: Colons versus periods in procedures containing


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

Sponsored Ads


Sponsored Ads