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.
There are differences in the contexts. For example, API documentation
for enterprise software doesn't look much like documentation for a
single widget.
There are differences in technology. Documentation for a Java
framework differs from that for a C++ app, a Perl library, or a set of
web services.
If you use "API docs" loosely to mean any docs for which the target
audience consists of programmers, then you have programming guides,
best practices, sample code, and so forth. ...RM
On Thu, Mar 4, 2010 at 9:28 AM, Keith Hood <klhra -at- yahoo -dot- com> wrote:
> 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?
--
Richard Mateosian <xrm -at- pacbell -dot- net>
Berkeley, California
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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-
