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