RE: About SDK documentation

Subject: RE: About SDK documentation
From: Matthew Horn <mhorn -at- macromedia -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Fri, 21 Mar 2003 07:18:02 -0500


> I'd like to be directed to a good site / book / article about SDK
> documentation... what it IS, what it consists of, how to go about it,
> etc.

I've written several SDK books, for OEM customers and power users of our products. When I first put one together I searched the web for any decent resources that would help me organize it and provide ideas. Unfortunately, I didn't find any.

What I found most useful was downloading SDKs from various vendor's websites and looking at THEIR documentation. n many cases, though, it was evident that the writers of those docs had no idea what to write, either, but I was able to combine the results of their efforts to put out my own docs.

Sounds like an opportunity.

HTH

Matthew J. Horn
Sr. Technical Writer
< m a c r o m e d i a >

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Order RoboHelp X3 and receive a $100 mail-in rebate, plus FREE
RoboScreenCapture, WebHelp Merge Module and iMarkupSoftware, for a total
giveaway value of $473! Order here: http://www.ehelp.com/techwr-l

Help celebrate TECHWR-L's 10th Anniversary starting this month!
Check out the contests at http://www.raycomm.com/techwhirl/special/contests/
Happy birthday to you, happy birthday to you, happy birthday TECHWR-L....

---
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: ADMIN: About that spam
Next by Author: Category vs. Alphabetical Listing in Contents Tab in Online Help
Previous by Thread: RE: About SDK documentation
Next by Thread: What is required to be a tech writer?


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


Sponsored Ads