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.
> I had a phone interview yesterday with someone who wanted details about my experience with API documents. One of the questions asked was, "What kind of API documentation have you worked with?"
>
> Here's the (stupid) question - is there more than one type?
The most obvious difference is that an object-oriented API requires a very different approach to documentation than does a function-oriented API. And there are some significant differences between what's required for a low-level, generic API (e.g. a programming language's standard library) versus a high-level, application-specific API. And since all developers like to think that there is something unique (or at least special) about their own work product, it often happens that any given company will find some way to dismiss your prior API documentation experience as irrelevant because of their unique requirements.
But you might want to cast an eye on the Wikipedia article on application programming interfaces because it does provide a readable and mostly understandable overview of some of the different types of APIs.
Use Doc-To-Help's XML-based editor, Microsoft Word, or HTML and
produce desktop, Web, or print deliverables. Just write (or import)
and Doc-To-Help does the rest. Free trial: http://www.doctohelp.com
Explore CAREER options and paths related to Technical Writing,
learn to create SOFTWARE REQUIREMENTS documents, and
get tips on FUNCTIONAL SPECIFICATION best practices. Free at: http://www.ModernAnalyst.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
