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.
Yes, Tony, I failed to mention that this text is in the second column of a reference table. The first column lists the algorithm names; the second column briefly describes the algorithm behaviors.
Karen
My actions are my only true belongings- Thich Nhat Hanh
On Jul 19, 2013, at 10:06 AM, Tony Chung wrote:
> 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.
