RE: "Bad" documentation examples

Subject: RE: "Bad" documentation examples
From: "Robart, Kay" <Kay -dot- Robart -at- tea -dot- texas -dot- gov>
To: Ryan Young <ryangyoung -at- gmail -dot- com>, tech2wr-l <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 24 Nov 2015 14:45:17 +0000

You should check the government site for plain language. I think it's plainlanguage.gov. They have all kinds of things there, including the slide presentations for their Plain Language classes. Since present tense and active voice and so on are part of the plain language initiative, they should have examples.

-----Original Message-----
From: techwr-l-bounces+kay -dot- robart=tea -dot- texas -dot- gov -at- lists -dot- techwr-l -dot- com [mailto:techwr-l-bounces+kay -dot- robart=tea -dot- texas -dot- gov -at- lists -dot- techwr-l -dot- com] On Behalf Of Ryan Young
Sent: Monday, November 23, 2015 11:39 PM
To: tech2wr-l <techwr-l -at- lists -dot- techwr-l -dot- com>
Subject: "Bad" documentation examples

Hi everyone,

I'm putting together a presentation to help developers contribute to the documentation. Part of the presentation is general writing guidelines, like "use the active voice," "write in the present tense," "avoid ambiguous pronouns," keep things short"--all the usual suggestions. For this section, we'd like to provide some examples of the "bad" way to do things. There is obviously no shortage of these things and I'm going to try to cull as many as possible from our own docs, but, thankfully, what we do have is not that bad.

So, if you have any of these "bad" examples, please send them my way!

Thanks,
Ryan
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | http://techwhirl.com

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

You are currently subscribed to TECHWR-L as kay -dot- robart -at- tea -dot- texas -dot- gov -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
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | http://techwhirl.com

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

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


References:
"Bad" documentation examples: From: Ryan Young

Previous by Author: RE: XML to HTML conversion....
Next by Author: Re: group name - for client and server ?
Previous by Thread: RE: "Bad" documentation examples
Next by Thread: RE: FM (2015) - copy/paste and keep tracked changes ?


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

Sponsored Ads


Sponsored Ads