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 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: 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: http://www.ModernAnalyst.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-