Re: About SDK documentation?

Subject: Re: About SDK documentation?
From: "Karen E. Black" <kblack_text -at- hotmail -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Fri, 21 Mar 2003 10:49:15 -0500


I'm scheduled for two of their courses in April: How to Document APIs and SDKs, and Just Enough Java. I'll report...

They are running a 5-day series in Toronto; the last day is on marcomm -- would it give me ammo against our fearless and clueless Marketing Team?

Karen Black, can't convince them to use "if" instead of "should," "need" instead of "require," "more" instead of "further," "help" instead of "assistance," or "crap" instead of "verbage"

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Is fearr socrú dá dhonacht ná dlí dá fheabhas.
It's better to solve the problem than to improve the law.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

From: "Hart, Geoff" <Geoff-H -at- MTL -dot- FERIC -dot- CA>
Dennis Wilson reports: <<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.>>

How about trying the course workbook at
<http://www.gordonandgordon.com/api_workbook.html>? Manny Gordon and Gordon
Graham have been delivering this course (and their other courses) for a
while now, to uniformly positive reviews. I haven't reviewed this particular
workbook, but I've attended a many of their courses and lectures over the
years and always enjoyed them and learned something new.


_________________________________________________________________
STOP MORE SPAM with the new MSN 8 and get 2 months FREE* http://join.msn.com/?page=features/junkmail


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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: Novel Approach
Next by Author: Re: Opinions on www.techwritershome.cjb.net?
Previous by Thread: About SDK documentation?
Next by Thread: Reminder: Job satisfaction for technical writers survey


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


Sponsored Ads