RE: API doc question

Subject: RE: API doc question
From: <laura_johnson -at- agilent -dot- com>
To: <klhra -at- yahoo -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Fri, 5 Mar 2010 14:43:25 -0700

I'd say the right answer to the interview question would be to provide
detail about the API docs you've done (type of information, type of API,
tools used -- all the things folks have been mentioning in this thread)
until either you run dry, or the interviewer stops you (or asks you
follow-up questions to focus you more on whatever it is she was
interested in). Keith, your second post would've been a fine answer.
Shame you couldn't come up with it at the time, but of course that's the
awful thing about interviews.

-----Original Message-----
From: Keith Hood [mailto:klhra -at- yahoo -dot- com]
Sent: Thursday, March 04, 2010 10:28 AM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: API doc question

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:

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

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 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
API doc question: From: Keith Hood

Previous by Author: Re: SOAP documentation examples
Next by Author: Re: Waka waka bang splat
Previous by Thread: Re: API doc question
Next by Thread: Master resumes (was Re: API doc question)

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

Sponsored Ads