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: What do you know about API Documentation? From:Gerry Bourguignon <GBourgui -at- LAVASYS -dot- COM> Date:Tue, 17 Nov 1998 10:00:37 -0500
Not very much, really. I can tell you that the API doc I currently maintain
contains a list of available functions by category, along with definitions,
error messages, examples, and programmers notes. I did not define the
structure, but I understand that the developer responsible had suggested
something along the lines of a Microsoft manual he'd liked. The consistent
use of character formatting (bold and italics, for example) helps to
identify the syntax for each function. There are several ways to improve
accessibility, such as providing supplemental indices that list the
functions alphabetically or by any other criteria that might make sense
within your particular domain.
LAVA Systems Inc.
> -----Original Message-----
> From: Gina Hertel [SMTP:Ghertel -at- ALPHA88 -dot- COM]
> Sent: Monday, November 16, 1998 6:33 PM
> To: TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU
> Subject: What do you know about API Documentation?
> This is what I know about APIs:
> An API (application program interface) is the specific method by which a
> programmer writing an application program can make requests of the
> system or another application.
> This is what I need to know:
> 1. What kind of information might a Programmer's API guide include?
> 2. Does anyone have a template for API documentation?
> From ??? -at- ??? Sun Jan 00 00:00:00 0000=