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.
First let's not get into the 'developers don't know how to write' subject -
some write very well. You have to remember that developers are used to
looking at things like "users SHOULD have to be able to do this" and
writers look at things like "What DO I DO next to do what I need to do?".
The best way I have found to get a developer to examine 'just the facts,
m'am' is to ask for just the facts. If you get corrections on your writing
style, simply say thank you and then explain that you were looking for more
of a technical review for product accuracy.
"Leona L. Magee-Dupree" <leona -dot- magee-dupree -at- CCBCC -dot- COM> on 12/17/98 11:04:13
Please respond to leona -dot- magee-dupree -at- CCBCC -dot- COM
To: TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU
I gave a copy of instructions to a developer and the developer ignored the
instructions and changed the sentences from active to passive. The
developer tried to edit the documentation. What does a technical writer
have to do to get feedback about the accuracy of a document and not "tid
bits" of how to write from someone who does not know how to write? Why do
developers do this? How should we react?