Re: API's

Subject: Re: API's
From: "Susan W. Gallagher" <sgallagher -at- EXPERSOFT -dot- COM>
Date: Mon, 8 Sep 1997 10:18:46 -0700

Suzanne Maloon wonders:
>
>This probably may be a stupid question, and sorry if it's been asked
>before, but what, exactly is an API manual?

API = Application Programming Interface
API documentation presents a programmer with all the information
needed to integrate the documented application into the current
development project.

For example, a development team might use API documentation to
integrate a report or charting package into a database application.

In OO programming, an interface is the public side of an object --
a list of the messages it understands and the data it can deliver
to the requester.

HTH!

-Sue Gallagher http://pw1.netcom.com/~gscale/susanwg/
sgallagher -at- expersoft -dot- com http://www.expersoft.com

The _Guide_ is definitive.
Reality is frequently inaccurate. --Douglas Adams

TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html


Previous by Author: Re: need copyedit advice! what's a style sheet?
Next by Author: Re: What does a tech writer do? (fwd)
Previous by Thread: API's
Next by Thread: Re: TECHWR-L Digest - 4 Sep 1997 to 5 Sep 1997


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


Sponsored Ads