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:Quotation marks around user interface labels From:Nancy Allison <maker -at- verizon -dot- net> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Mon, 18 Jul 2011 16:05:19 -0500 (CDT)
I seem to have lost my bearings about when to use quotation marks. I'm working on release notes that describe fixes to individual check boxes and fields in the user interface.
What would you for a sentence like this:
---Added a check on Out of Office reply in the Scheduling Conditions section before the Print routine.
I wouldn't use quotation marks or a special font for any of that, would you? Aren't the capitals enough to make it clear that proper names are being used?
But what about this:
---Fixed the bug that prevents Diagnostic: Outboard from being deleted.
That looks more like a heading that might be generated and displayed for a while under certain circumstances. I might be tempted to put quotation marks around "Diagnostic: Outboard."
The problem is made more difficult by the fact that I don't have time to check all these things out in the user interface. Even if I did, I don't know how to set up the conditions that generate some, or even a lot, of the errors that have been corrected.
I'm really working in the dark and on a tight deadline, too.
Do you have a rule of thumb about using quotation marks for field names, dialog box titles, message text, and the like?
Thanks for any and all suggestions.
Create and publish documentation through multiple channels with Doc-To-Help.
Choose your authoring formats and get any output you may need. Try
Doc-To-Help, now with MS SharePoint integration, free for 30-days. http://www.doctohelp.com
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-