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.
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