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:What do you know about API Documentation? From:Gina Hertel <Ghertel -at- ALPHA88 -dot- COM> Date:Mon, 16 Nov 1998 18:33:28 -0500
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 operating
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?
