Re: Nightmare Library

Subject: Re: Nightmare Library
From: Chris Morton <salt -dot- morton -at- gmail -dot- com>
To: "techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Mon, 20 Feb 2017 09:06:22 -0500

Although not the original intent, NIST has some really pathetic examples,
especially in relation to internet security.

As for writing clearly, William Zinsser's *On Writing Well* is a terrific
resource.

Chris Morton



â Substantive Editing â Technical Writing â Proofreading
â Marketing Expertise â Mentoring
Click to
<http://t.sidekickopen68.com/e1t/c/5/f18dQhb0S7lC8dDMPbW2n0x6l2B9nMJN7t5XYgdnqQxW7fsH3H4XrddKW1pNgV-56dMhqf2Q-c6C02?t=https%3A%2F%2Fwww.linkedin.com%2Fpub%2Fchris-morton%2F2%2F166%2F6ba&si=6020636811198464&pi=d9cb9cca-9711-4187-97ba-db88dbdda463>


On Mon, Feb 20, 2017 at 8:45 AM, Wright, Lynne <Lynne -dot- Wright -at- kronos -dot- com>
wrote:

> If you can't find any samples of bad tech writing, what you could do is
> take a paragraph from an academic paper that's full of convoluted, jargony
> sentences (in one of the particularly theoretical fields like philosophy,
> film or architectural theory, or anthropology) and re-express the core idea
> in simple terms.
>
> Although if they don't already take your word, as a native English
> speaker, about how to communicate effectively in English, you may never get
> through to them.
>
> -----Original Message-----
> From: techwr-l-bounces+lynne -dot- wright=kronos -dot- com -at- lists -dot- techwr-l -dot- com [mailto:
> techwr-l-bounces+lynne -dot- wright=kronos -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf Of
> Zev Levi
> Sent: February-20-17 2:24 AM
> To: techwr-l <techwr-l -at- lists -dot- techwr-l -dot- com>
> Subject: Nightmare Library
>
> 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 Lynne -dot- Wright -at- kronos -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 salt -dot- morton -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 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:
Nightmare Library: From: Zev Levi
RE: Nightmare Library: From: Wright, Lynne

Previous by Author: Cloud backup?
Next by Author: Re: punctuation et al. rules
Previous by Thread: RE: Nightmare Library
Next by Thread: Re: Nightmare Library


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

Sponsored Ads


Sponsored Ads