Re: API docs, what are they named?

Subject: Re: API docs, what are they named?
From: "Steven J. Owens" <puff -at- NETCOM -dot- COM>
Date: Fri, 16 Jan 1998 16:22:41 -0800

Van Fujimoto (hopad -at- ix -dot- netcom -dot- com) writes:
> This is a follow up to my API definition question.
> What kind of documents does API documentation typically belong in
> or are they their own documents like "API for module abc" ?

As an API is somewhat analogous to a programming language, I'd
say it follows the same rules for programming language references. Most
of the times I've done (or helped with) API refs it was as part of a
language ref or as an accompanying volume to a language ref.

Steven J. Owens
puff -at- netcom -dot- com
puff -at- rt1 -dot- net
http://www.rt1.net/puff




Previous by Author: Re: Advise for beginers
Next by Author: Re: What is a TW?
Previous by Thread: API docs, what are they named?
Next by Thread: Need Templates for Word Manuals


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


Sponsored Ads