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.
I recently received the two books Gordon & Gordon
wrote for technical writers. While I found "System
Design for Technical Writers" to be helpful, I was
less pleased with "Documenting APIs and SDKs." That's
not to say that the material wasn't comprehensive or
that that class wouldn't have been *great*; it's just
that I was expecting quite a bit more for $85. With no
prior API writing experience, the book (which is
really a PowerPoint presentation in GBC binding
without speaker notes) is really just a guide for the
class.
Now that I'm actually starting to document SDKs and
APIs, the workbook will prove handy, buy it's not the
best starting place for a newbie. IMHO.
There was a long thread on this subject about a month
ago; if you search the archives for APIs you should
get a ton of hits. If I can find the messages I
received from the TECHWR-Lers who responded to my
questions, I'll forward them to you.
Meanwhile, here are a couple sites I found helpful
I don't know your background, but if you go this
route, you will have to know some code. Either C or
Java is a pretty good place to start. For less than
$10 pick up "The Elements of Java Style" for an
excellent intro to OOP.
HTH
Kelly
P.S. Feel free to contact me for more details, but
please e-mail me and not the list, as I am on digest.
__________________________________________________
Do You Yahoo!?
Get personalized email addresses from Yahoo! Mail http://personal.mail.yahoo.com/
*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available now at http://www.devahelp.com or info -at- devahelp -dot- com
TECH*COMM 2001 Conference, July 15-18 in Washington, DC
The Help Technology Conference, August 21-24 in Boston, MA
Details and online registration at http://www.SolutionsEvents.com
---
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.
