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.
RE: Example of clear tech-comms and policy guidance writing this good
Subject:RE: Example of clear tech-comms and policy guidance writing this good From:"Dan Goldstein" <DGoldstein -at- riverainmedical -dot- com> To:<techwr-l -at- lists -dot- techwr-l -dot- com> Date:Wed, 18 Mar 2009 10:19:59 -0400
> -----Original Message-----
> From: McLauchlan, Kevin
> Sent: Wednesday, March 18, 2009 9:55 AM
> To: Dan Goldstein; techwr-l -at- lists -dot- techwr-l -dot- com
> Subject: RE: Example of clear tech-comms and policy guidance
> writing this good
>
> Up to and including page 8, I've found some instances where
> the writer should have paid attention to sentence-structure
> parallelism among bullet-list points. In fact, some were full
> sentences while others were fragments. But they were
> obviously bullet points, and they conveyed their information
> briskly and without inducing any stumbling on my part.
>
> Other than that breakdown of parallelism (oh, the horror) I
> found what Daniel found - good, clear, engaging writing,
> where somebody obviously put a lot of thought into both the
> content and the organization/presentation of that content.
>
> So, what aspects of the writing offended you? Do I need to
> read further to find them, or did I overlook them already?
>
I didn't say I was offended. I said it was poorly written.
Consider the first sentence in Objectives: "[One] objective of this
section is to enable you to understand how recording calls and keeping
records can benefit the school." Or another sentence, about five lines
down: "[One] objective of this section is to enable you to understand
how using the service desk will help the technical support function
become more effective." Such wordy, frothy sentences can be found
throughout the work; any good editor could trim them with little effort.
There are some sentences whose broken syntax suggests a non-native
writer: "The turnaround of user requests is faster, yielding improved
efficiency and request tracking, escalation and workflow is improved."
I was also struck by the general comma-phobia, which slows down and
occasionally confuses the reader.
This work is hardly an example of "simple, clear writing." But I agree
that the presentation shows a lot of thought.
This message contains confidential information intended only for the use of the addressee(s). If you are not the addressee, or the person responsible for delivering it to the addressee, you are hereby notified that reading, disseminating, distributing, copying, electronic storing or the taking of any action in reliance on the contents of this message is strictly prohibited. If you have received this message by mistake, please notify us, by replying to the sender, and delete the original message immediately thereafter. Thank you.
ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing
solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or
HTML and publish to the Web, Help systems or printed manuals. http://www.doctohelp.com
Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control! http://www.helpandmanual.com/
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-