Re: API doc question

Subject: Re: API doc question
From: Richard Mateosian <xrmxrm -at- gmail -dot- com>
To: TECHWR-L <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 4 Mar 2010 09:50:32 -0800

There are differences in the contexts. For example, API documentation
for enterprise software doesn't look much like documentation for a
single widget.

There are differences in technology. Documentation for a Java
framework differs from that for a C++ app, a Perl library, or a set of
web services.

If you use "API docs" loosely to mean any docs for which the target
audience consists of programmers, then you have programming guides,
best practices, sample code, and so forth. ...RM

On Thu, Mar 4, 2010 at 9:28 AM, Keith Hood <klhra -at- yahoo -dot- com> 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?

Richard Mateosian <xrm -at- pacbell -dot- net>
Berkeley, California

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: RE: RE: my bad displays habit
Next by Author: Re: OT: Profanity in the workplace
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