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.
On Wed, Aug 13, 2014 at 4:52 PM, Robert Lauriston <robert -at- lauriston -dot- com>
wrote:
> 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 loisrpatterson -at- gmail -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
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Read about how Georgia System Operation Corporation improved teamwork, communication, and efficiency using Doc-To-Help | http://bit.ly/1lRPd2l
