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.
> OK, gang. I suspect that a pretty small subset of us deals in
> documenting Application Programming Interfaces.
> I'm documenting APIs for our product, and there are three flavors
> of API: [...]
> I'd like a "handle" I can use to refer to this set of three
> "ways to access the system".
>
> In the case of the C API, any language that can create calls that are
> The Java API is object oriented. Essentially for each call
> in the C API, there is a class in the Java API that is instantiated
> The COM API is not now object oriented, but might become so.
>
> Has any of you ever had to address this sort of a problem, where
> there are multiple APIs that provide entree to a system/product
Sounds like you're answering your own question. Call them "the
three APIs." As a programmer, I can tell you that wouldn't put me off
too much. Of course, I wouldn't be horribly put off by "protocol",
either, but API works just fine.
Steven J. Owens
puff -at- guild -dot- net
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Learn how to develop HTML-based Help with Macromedia Dreamweaver!
Dec. 7-8, 2000, Orlando, FL -- $100 discount for STC members. http://www.weisner.com/training/dreamweaver_help.htm or 800-646-9989.
Your web site localized into 32 languages? Maybe not now, but sooner than
you think. Download ForeignExchange's FREE paper, "3 steps to successful
translation management" at http://www.fxtrans.com/3steps.html?tw.
---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.