Editor's Corner

Hello! I send emails to Symitar writers and writers in other JHA companies twice a week. The emails are called Nifty Nuggets, and they and provide writing tips in bite-sized portions. I’ll be sharing some nuggets of information with you while I guest-host the Editor’s Corner.

Today’s topic is about clear writing. Clear writing makes it easier for readers to understand the information and processes in technical documentation. Here are some tips from an article called “20 Strategies for Writing in Plain Language” from Daily Writing Tips:

· Identify and understand your readers and their needs: Who are they, and what is their likely reading level? What do they already know about the subject, and what do you want them to know? What do you need to write to convey this information? [JS – You need to know your audience so you can write effectively.]

· Write short sentences; keep the subject, verb, and object close. Place words carefully, and avoid double negatives. [JS – Lengthy sentences make writing difficult to read and understand. Readers should not lose their breath when reading sentences aloud. Trim sentence length by breaking long sentences into two or more separate sentences.]

· Write short paragraphs consisting of one topic, each starting with a topic sentence and linked to other paragraphs with transitional words and phrases such as next or “once you have submitted your application.” [JS – Transitions connect your paragraphs into logically coherent information. Whether they are single words, quick phrases, or full sentences, transitions help readers understand how the information works together. Transitions make
your writing clear and understandable for the reader.]

· Write to the reader, using second-person pronouns rather than third-person pronouns: “You must provide written proof”; “We will respond within seven business days.” This approach encourages you to write in active voice. Define the pronouns so that readers are clear about the categories of people or other entities—audience, information providers, and third parties — referred to as you, we, and they. [JS – Sometimes passive voice is acceptable; however, try to write in active voice as much as possible. Using active voice makes your writing clearer because
you identify the subject performing the action.]

· Don’t shy away from technical terms your audience knows, but avoid jargon. [JS – Avoid using jargon in your writing unless it is appropriate for the audience and no other words fit the situation.]

· Omit unnecessary words: Watch for verbose phrases. [JS – Avoid redundancies and wordy phrases in your writing because they distract, confuse, and bore readers. Make your writing more concise and less time-consuming for the
reader by getting to the point in as few words as possible.]

Jackie Solano | Technical Editor | Symitar®

8985 Balboa Ave. | San Diego, CA 92123 | Ph. 619.542.6711 | Extension: 766711

NOTICE: This electronic mail message and any files transmitted with it are intended
exclusively for the individual or entity to which it is addressed. The message,
together with any attachment, may contain confidential and/or privileged information.
Any unauthorized review, use, printing, saving, copying, disclosure or distribution
is strictly prohibited. If you have received this message in error, please
immediately advise the sender by reply email and delete all copies.