Nightmare Library

Subject: Nightmare Library
From: Zev Levi <j -dot- zev -dot- levi -at- gmail -dot- com>
To: techwr-l <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Mon, 20 Feb 2017 07:24:07 +0000

Hi all,

I work in a country where English is spoken as a second language (if at
all) and I often find myself explaining to product managers and developers
why their documentation ideas are troublesome. ("Yes, the sentence you
changed is clear to you but, as it's now five lines long, it is confusing
to readers. We must explain ideas using shorter sentences.")

Is anyone aware of a virtual library of bad-documentation examples (a
library of tech-doc nightmares)? I'd like to search for *long sentences*
and find examples of unclear documentation.

It would be easier to convince PMs of writing guidelines if they tried
reading a doc that didn't follow them.

I haven't had any luck googling these terms; I'm looking for documentation
examples and google generally returns links to forums.

Cheers

Zev


--

*Zev Levi*


Technical Writer
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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


Follow-Ups:

Previous by Author: Re: What would you do?
Next by Author: Re: Nightmare Library
Previous by Thread: Tech Writers in Phoenix AZ
Next by Thread: Re: Nightmare Library


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

Sponsored Ads


Sponsored Ads