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.
RE: Colons versus periods in procedures containing illustrations
Subject:RE: Colons versus periods in procedures containing illustrations From:Paul Hanson <twer_lists_all -at- hotmail -dot- com> To:Lin Sims <ljsims -dot- ml -at- gmail -dot- com>, TECHWR-L <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Mon, 26 Nov 2018 21:58:05 +0000
I have always used a "1. Click Configure." structure. Whether there is a screen capture or not never has entered my reasoning for doing so as it's a sentence.
In my opinion, I would be hard-pressed to base the punctuation in the procedure upon whether a screen capture is included. There may be one "today" but that's not to say there always will be, for example, if you are single-sourcing for either print or online and have a requirement to not have screen captures in one of the outputs.
-----Original Message-----
From: techwr-l-bounces+twer_lists_all=hotmail -dot- com -at- lists -dot- techwr-l -dot- com [mailto:techwr-l-bounces+twer_lists_all=hotmail -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf Of Lin Sims
Sent: Monday, November 26, 2018 3:35 PM
To: TECHWR-L
Subject: Colons versus periods in procedures containing illustrations
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
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
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | https://techwhirl.com
