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'd appreciate any pointers you have to "best of breed"
> developer or API documentation. If you have time to offer
> commentary on what makes it so good, that's all the better.
Anytime I've been asked this in the past, I've pointed people to the API
documentation that Sun created for its Java language. In my role as developer,
I've found them to be easy to navigate (their best feature), full of examples
that help me to understand what I'm supposed to do, and descriptive enough to
get the point across, without going on at length.
Other API docs that were good were those that came with Delphi 3, from
Borland/Inprise. Unfortunately, all that made them good disappeared from them
when it went to Delphi 4. In fact, I liked some of the aspects of the Delphi 3
docs so much that I replicated them in my own developer docs.
For non-API developer documentation, I have to rave about the book I read on
JavaServer Pages technology: Web Development with JavaServer Pages
(http://www.amazon.com/exec/obidos/ASIN/1884777996/o/qid=987004502/sr=2-1/107-9744687-7326928).
It's the best developer doc I've ever read. I read it straight through, only
skipping one chapter. The folks on Amazon seem to agree with my
assessment...it's got 4.5 of 5.0 stars.
*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available 4/30/01 at http://www.devahelp.com or info -at- devahelp -dot- com
Sponsored by DigiPub Solutions Corp, producers of PDF 2001 Conference East,
June 4-6, Baltimore, MD. Now covering Acrobat 5. Early registration deadline
April 27. http://www.pdfconference.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.
