API doc question

Subject: API doc question
From: Keith Hood <klhra -at- yahoo -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Thu, 4 Mar 2010 09:28:08 -0800 (PST)

I had a phone interview yesterday with someone who wanted details about my experience with API documents. One of the questions asked was, "What kind of API documentation have you worked with?"

Here's the (stupid) question - is there more than one type?

Obviously I didn't get the job. (I messed with API docs once, for about a year, and that was over 4 years ago.)


Use Doc-To-Help's XML-based editor, Microsoft Word, or HTML and
produce desktop, Web, or print deliverables. Just write (or import)
and Doc-To-Help does the rest. Free trial: http://www.doctohelp.com

Explore CAREER options and paths related to Technical Writing,
learn to create SOFTWARE REQUIREMENTS documents, and
get tips on FUNCTIONAL SPECIFICATION best practices. Free at:

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/ for more resources and info.

Please move off-topic discussions to the Chat list, at:


RE: Profanity in the workplace (Dan Goldstein): From: Paul Moloney

Previous by Author: RE: Top 10 mistakes unstructured FrameMaker Users make in contentbeforetranslation
Next by Author: RE: API doc question
Previous by Thread: RE: Profanity in the workplace
Next by Thread: RE: API doc question

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

Sponsored Ads