RE: "Bad" documentation examples

Subject: RE: "Bad" documentation examples
From: Deidre Guy <DGuy -at- hcad -dot- org>
To: techwr-l <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 24 Nov 2015 14:13:53 +0000

Lois,

Thanks for sharing they are hilarious! :)

Warmest, Regards,
Deidre A. Guy
Technical Writer
Harris County Appraisal District
Comercial Property Division
7139575205


-----Original Message-----
From: techwr-l-bounces+dguy=hcad -dot- org -at- lists -dot- techwr-l -dot- com [mailto:techwr-l-bounces+dguy=hcad -dot- org -at- lists -dot- techwr-l -dot- com] On Behalf Of Lois Patterson
Sent: Tuesday, November 24, 2015 2:57 AM
To: Ryan Young; techwr-l
Subject: Re: "Bad" documentation examples

This Twitter account is a bit peripheral to your presentation, but I will mention it regardless.

https://twitter.com/uselessassist


On Mon, Nov 23, 2015 at 9:38 PM, Ryan Young <ryangyoung -at- gmail -dot- com> wrote:

> 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 loisrpatterson -at- gmail -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
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | http://techwhirl.com

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

You are currently subscribed to TECHWR-L as DGuy -at- hcad -dot- org -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
Re: "Bad" documentation examples: From: Lois Patterson

Previous by Author: Re: which MOOC providers do employers like?
Next by Author: RE: What is embedded help?
Previous by Thread: Re: "Bad" documentation examples
Next by Thread: RE: "Bad" documentation examples


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

Sponsored Ads


Sponsored Ads