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 style guides? From:"Pilipovich, Kathleen" <Kathleen -dot- Pilipovich-1 -at- KMAIL -dot- KSC -dot- NASA -dot- GOV> Date:Thu, 21 May 1998 16:56:13 -0400
>> Can you point me to some standard format(s)
> you've found, or is there no real standard?
I've documented functions in libraries. It sounds similar to
what you're doing. I don't know of any standards out there.
I took much of the info from the headers in the functions.
I worked with the software developers to include the other
information they wanted included. We came up with a
format that works for them. If you'd like a .pdf of a small
book I've done, you can write me directly.
United Space Alliance
Kathleen -dot- Pilipovich-1 -at- ksc -dot- nasa -dot- gov