Re: Colons versus periods in procedures containing illustrations

Subject: Re: Colons versus periods in procedures containing illustrations
From: Thorsten Konersmann <tk -at- documentation -dot- engineering>
To: Lin Sims <ljsims -dot- ml -at- gmail -dot- com>
Date: Mon, 26 Nov 2018 23:26:28 +0100

>From a functional point of view, I understand your plain text example in
such a way that the colon is supposed to clarify the reference from the
step to the illustration (namely, to the illustration following the colon,
below the step).

Principally, the layout of step-by-step instructions should always be
unambiguous about which step refers to which illustration (e.g., the
illustration placed above or below the step or which of the illustrations
placed in the marginal column).

If the reference from the step to the illustration is unambiguous in the
layout, the colon does not serve a functional purpose, or does it?

Apart from this functional argument, is there another argument to be made
purely regarding punctuation and style?

On Mon 26. Nov 2018 at 22:34 Lin Sims <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]
>
> --
> Lin Sims
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> Visit TechWhirl for the latest on content technology, content strategy and
> content development | https://techwhirl.com
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> You are currently subscribed to TECHWR-L as tk -at- documentation -dot- engineering -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
>
--
Von unterwegs gesendet | Sent from my mobile

http://www.documentation.engineering/
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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


Follow-Ups:

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

Previous by Author: Re: TECHWR-L Digest, Vol 157, Issue 14
Next by Author: Re: Git for Tech Pubs [was FW: L@@king for recommendations for a doc source-file management system....]
Previous by Thread: RE: Colons versus periods in procedures containing illustrations
Next by Thread: Re: Colons versus periods in procedures containing illustrations


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

Sponsored Ads


Sponsored Ads