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.
The Chicago Manual of Style police will write me up, I'm sure, but
punctuation serves to make written communication more clear.
In your examples, I don't see that the lack of a period would further
clarify the communication. Since you've limited real estate on which to
display the data, and likely limited Karmic points with the developers,
I'd let it ship as is, and save my energy for other, more important
short version -- is this a hill you are willing to die on?
From: Ladonna Weeks [mailto:ladonna -dot- weeks -at- comtrak -dot- com]
Sent: Tuesday, April 17, 2007 12:53 PM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Your thoughts on punctuation?
Our product has a keypad used for installation and diagnostics.
It can display up to four lines of 20 characters each. What is
correct punctuation for brief, informative statements, such as
(line 1) Calling server
(line 4) Please wait
Should there be a period after each statement? I'm having trouble
getting the programmers to add periods and I wonder if the
convention for such displays is to leave them off. What is your
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
Now shipping: Help & Manual 4 with RoboHelp(r) import! New editor,
full Unicode support. Create help files, web-based help and PDF in up
to 106 languages with Help & Manual: http://www.helpandmanual.com
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-