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.
As the lonely techwriter, one of my tasks is to come up with standards for
documenting APIs. I'm completely familiar with creating end-user (consumer)
manuals and the like; however, I was wondering if the nature of the subject
merits some other things to watch out for and include.
Since I have the chance to do things right from the beginning (rather than
to inherit some process or template), I was wondering if someone could point
me in the right direction: Is there some documentation (online or in print)
that is considered a "standard" or "classic" in terms of how to structure
such a document? What to include? Etc. I picture a document of this nature
can be as detailed as you want it to be. However, working under time (and
work-load) constraints what are the minimum requirements for such a
document. (Of crouse, I figure I can always ask for more time if the
end-result helps raise interest in the product on a larger scale.)
Thanks for your feedback.
Michael Koch
iSpheres Corporation
_____________________________
Michael Koch
iSpheres Coproration
640 Third Street
Oakland, CA 94607
510.302.6720 (vox)
510302.6723 (fax)
