RE: API doc question

Subject: RE: API doc question
From: Fred Ridder <docudoc -at- hotmail -dot- com>
To: <klhra -at- yahoo -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 4 Mar 2010 13:23:46 -0500


Keith Hood wrote:

> 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?


The most obvious difference is that an object-oriented API requires a very different approach to documentation than does a function-oriented API. And there are some significant differences between what's required for a low-level, generic API (e.g. a programming language's standard library) versus a high-level, application-specific API. And since all developers like to think that there is something unique (or at least special) about their own work product, it often happens that any given company will find some way to dismiss your prior API documentation experience as irrelevant because of their unique requirements.

But you might want to cast an eye on the Wikipedia article on application programming interfaces because it does provide a readable and mostly understandable overview of some of the different types of APIs.

-Fred Ridder

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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-

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:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat


Follow-Ups:

References:
RE: Profanity in the workplace (Dan Goldstein): From: Paul Moloney
API doc question: From: Keith Hood

Previous by Author: What if The Office had an episode about a technical communicator?
Next by Author: RE: Graphics question
Previous by Thread: RE: API doc question
Next by Thread: Re: API doc question


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

Sponsored Ads


Sponsored Ads