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.
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.
