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.
Hi, Techwhrlrs, I've searched the archives but not found anything about
styles for documenting APIs. I have one from a programmer (C++) that
doesn't seem to follow any conventions I've found in looking at APIs
such as HTMLHelp, Java classes, and MAPI32 for Visual Basic. Can you
point me to some standard format(s) you've found, or is there no real
standard? The above examples were not all alike.
For starters, it looks like you have a list of functions, with name,
description, parameters, values, returns, and then perhaps related
functions/methods and a code sample. Is some of this dependent on
Please don't tell me not to do it because I'm not a programmer --I
really don't have a choice, and besides I want to learn.
Risk Management Technologies