Technical Writers Needed for API Doc: Really?

Subject: Technical Writers Needed for API Doc: Really?
From: "Cedric Simard" <cedricns -at- hotmail -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Fri, 11 Jan 2002 11:18:28 +0100

Hi all,

I'm looking for resources (an article, a particular messsage in a forum, a page on web site...) that talk about the added-value of technical writers when it comes to documenting an API.

All CTOs and most of the programmers I've met till now keep on saying that only a programmer can produce documentation for programmers. As you can imagine, I've tried convincing them by defining more precisely what a technical writer is and what it can bring to such projects.

Still, they think it would be too expensive to train a technical writer so that he/she can become independent enough to document APIs. The result is they would not even let any chance to this idea. The only thing they agree with is that the technical writer can proofread the documentation to put it in proper English.

I do not like the idea of tech writer being only a proofreader. The technical writer can also bring his/her skills on documentation structure and information management. Still, I have to admit I'm still wondering if all those CTOs and developers are not right, after all?

What's your opinion?
Any resources and ideas are welcome!

MSN Photos is the easiest way to share and print your photos:

Collect Royalties, Not Rejection Letters! Tell us your rejection story when you submit your manuscript to iUniverse Nov. 6 -Dec. 15 and get five free copies of your book. What are you waiting for?

Have you looked at the new content on TECHWR-L lately?
See and check it out.

You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit for more resources and info.


Previous by Author: PDF Conversion Problem, using Word
Next by Author: RE: Test Scripts/ Test Specifications
Previous by Thread: Re: Editing Marks - Please Help!!!
Next by Thread: RE: Technical Writers Needed for API Doc: Really?

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

Sponsored Ads