Re: Technical Writers Needed for API Doc: Really?

Subject: Re: Technical Writers Needed for API Doc: Really?
From: "Diane Evans" <diane_evans -at- hotmail -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Fri, 11 Jan 2002 17:01:40


I> have seen that having the programmers who developed

the API write the doc can be a real problem.

They tend to suffer from a "programmers R us" illusion.

This was a major problem with the SDK that I put out just before leaving my last job (involuntarily). The programmers kept insisting that no more instructions were needed because a good programmer should "just know this."

When we released the SDK, the team that had to implement it got confused because one file needed to be renamed. There were no specific instructions as to which file or what the name should be. It took them three hours to figure it out.

The SDK manager sent out an email outlining the problem, frustration, and solution. I simply copied the email, pasted it into the appropriate place in the SDK, and made the letters bold red. I then asked for a better way to say this, but the team still didn't think it was important. I suppose the SDK still has this page in it.

Diane

_________________________________________________________________
Chat with friends online, try MSN Messenger: http://messenger.msn.com


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Attention ForeHelp and Doc-to-Help Users! Upgrade your existing product to RoboHelp for FREE, through January 15th. RoboHelp can import your existing Help projects! Learn how else RoboHelp can benefit you. www.ehelp.com/techwr

---
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 http://www.raycomm.com/techwhirl/ for more resources and info.



Previous by Author: Re: Extreme Technical Writing (was RE: Flexibility and changing requirements)
Next by Author: Re: I like mine better, but I don't know why.
Previous by Thread: FW: Technical Writers Needed for API Doc: Really?
Next by Thread: Re: Technical Writers Needed for API Doc: Really?


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

Sponsored Ads


Sponsored Ads