Re: Comma question

Subject: Re: Comma question
From: Tony Chung <tonyc -at- tonychung -dot- ca>
To: Karen Felker <akaren -at- earthlink -dot- net>
Date: Fri, 19 Jul 2013 10:06:47 -0700

Hi Karen,

It doesn't help that you don't have a complete sentence. A missing subject
can cloud anyone's perception of how the language is used.. While this
style is common in API docs, just know that the comma rules should
technically follow a proper sentence structure.

Your comma placement with subject added:
{The shplee method} assigns numbers to actors and events, based on natural
groups called clusters.

Your alternate suggestion:
{The shplee method} assigns numbers, based on natural groups called
clusters, to actors and events.

Your alternate alternate suggestion:
{The shplee method} assigns numbers to actors and events. The numbers are
based on natural groups called clusters.


Your alternate suggestion works because the clause modifies "numbers"
instead of the "actors and events".

My preference is your alternate alternate suggestion, primarily for clarity
and plain language. The short sentences will aid translation or
interpretation by non-English speakers.

-Tony


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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:
Comma question: From: Karen Felker

Previous by Author: Re: ever taken classes - from BigDataUniversity?
Next by Author: Re: SharePoint question
Previous by Thread: RE: Comma question
Next by Thread: Re: Comma question


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

Sponsored Ads


Sponsored Ads