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:Users vs. usage From:SIANNON -at- VISUS -dot- JNJ -dot- com To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Mon, 17 Dec 2001 13:57:30
I would like to submit a nit for picking (sort of a brief survey):
Document:
You are writing a System Functionality test for a change to a system.
Audience:
You are faced with a literalist user/tester base -- e.g., technophobic
users, non-academically-inclined (i.e., often unaware of half the rules for
grammatically-correct writing, and prone to avoid reading when possible),
and yet for that very reason being used as the testers performing the
test.
Variable:
The document convention (used consistently) is that literal text to be
entered into a control during the test is enclosed in quotes. (This is in
part because the users in question ignore or don't notice font changes or
italics as emphasis in this case.)
Usage question:
In this case, if it becomes necessary to include a comma after the
quote-enclosed text (for the sake of the appropriate pause needed in the
sentence describing the step to be taken), would you prefer to place it
inside or outside of the quote marks?
Grammar indicates it should go inside the quotes, clarity indicates it
should go outside the quotes.
I'm seeking a view of where the opinions lie, proportionally along the
continuum, mostly as a gauge for future encounters of this nature. I keep
stubbing my toe on this incarnation of the usage necroequine, so I figure I
may have lost perspective by now.
Thanks!
Shauna
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Collect Royalties, Not Rejection Letters! Tell us your rejection story when you
submit your manuscript to iUniverse Nov. 6 -Dec. 15 and get five free copies of
your book. What are you waiting for? http://www.iuniverse.com/media/techwr
---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.