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.
the dearth of documents on documenting APIs and SDKs
Subject:the dearth of documents on documenting APIs and SDKs From:Mandy Wells <mwells -at- valadeo -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 10 Jul 2001 11:22:10 -0400
Carol wrote:
:: Hi, I've been looking for a book to learn api
:: documentation...
And I, too, have looked high and low for a book on writing APIs and SDKs,
and although there are vast rafts of books on being a technical writer,
managing documentation, writing for on-line and off-line, books for dummies,
idiots and everyone else, there is nothing (nothing except the Gordon and
Gordon workbook) for writing APIs and SDKs.
Why is that? And, why haven't one of you brilliant API/SDK documenters
documented the process and sat back to rake in the millions of dollars (OK,
hundreds...hmm, maybe tens of dollars) flowing in from grateful
not-technical writers like me?
*** 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.
