Re: Basic API Information

Subject: Re: Basic API Information
From: Robert Lauriston <robert -at- lauriston -dot- com>
To: "Gillen, Lori" <Lori -dot- Gillen -at- mckesson -dot- com>, "techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 13 Aug 2014 16:52:17 -0700

The Wikipedia summary is pretty good:

http://en.wikipedia.org/wiki/Application_programming_interface#API_documentation

Beyond that, API documentation involves a large and ever-changing set
of concepts. What you need to know depends on what language the API is
written in, which standard it conforms to (if any), and whether
generation of the API doc is or can be automated.

For example, documenting a Java API using javadoc or a C++ API using
Doxygen is (typically) radically different from documenting a REST API
written in JavaScript or Python.

On Wed, Aug 13, 2014 at 12:04 PM, Gillen, Lori <Lori -dot- Gillen -at- mckesson -dot- com> wrote:
> Can anyone recommend some basic conceptual API information? Would the Gordon and Gordon workbook be helpful?

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Read about how Georgia System Operation Corporation improved teamwork, communication, and efficiency using Doc-To-Help | http://bit.ly/1lRPd2l

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

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-leave -at- lists -dot- techwr-l -dot- com


Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwhirl.com/email-discussion-groups/ for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives


Follow-Ups:

References:
Basic API Information: From: Gillen, Lori

Previous by Author: Re: Framemaker - Save as HTML, but something is wrong with the CSS
Next by Author: Re: Basic API Information
Previous by Thread: RE: Basic API Information
Next by Thread: Re: Basic API Information


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


Sponsored Ads