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.
Subject:Re: Nightmare Library From:Ryan Haber <ryan -dot- haber -at- gmail -dot- com> To:Zev Levi <j -dot- zev -dot- levi -at- gmail -dot- com>, techwr-l <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Mon, 20 Feb 2017 13:33:45 +0000
Do you think showing them a simple guide to good tech writing might help?
That would probably be easier to acquire.
On Mon, Feb 20, 2017, 05:52 Zev Levi <j -dot- zev -dot- levi -at- gmail -dot- com> wrote:
> 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 ryan -dot- haber -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
>
--
All the best,
Ryan
--
Ryan Haber
About.me/ryanhaber
301-908-3049
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | http://techwhirl.com
