Re: Punctuation in quotes -- American style

Subject: Re: Punctuation in quotes -- American style
From: Lauren <lauren -at- writeco -dot- net>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Mon, 19 Aug 2013 14:56:11 -0700

On 8/19/2013 2:38 PM, Janoff, Steven wrote:

We didn't have this problem years ago.

We also didn't have as many DIY users then. I think that when more work must be documented for the DIY users, more opportunities for errors arise and documentation must be clear and account for all reasonable possibilities.

So from a documentation perspective, if it is a possible that a user will interpret punctuation inside of quotes as part of a command, then the punctuation must be outside of the quotes. When the punctuation is outside of the quotes, it can annoy "grammatically-correct" users.

I work to craft my documents to avoid placing grammatical punctuation near command punctuation. That's what this discussion really comes down to, though. Isn't it? A conflict between rules of punctuation used in both grammar and codes.




^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
New! Doc-to-Help 2013 features the industry's first HTML5 editor for authoring.

Learn more: http://bit.ly/ZeOZeQ

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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:
Punctuation in quotes -- American style: From: Richard Hamilton
RE: Punctuation in quotes -- American style: From: Lynne Wright
Re: Punctuation in quotes -- American style: From: David Farbey
Re: Punctuation in quotes -- American style: From: Richard Hamilton
RE: Punctuation in quotes -- American style: From: Janoff, Steven

Previous by Author: Re: Punctuation in quotes -- American style
Next by Author: RE: Arguments for using illustrations instead of 3d animations
Previous by Thread: RE: Punctuation in quotes -- American style
Next by Thread: Re: Punctuation in quotes -- American style


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

Sponsored Ads


Sponsored Ads