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.
MadCap has included a very good presentation on their demos page about writing API documentation. See "APIs and SDKs - Breaking into and Succeeding in a Specialty Market" on http://www.madcapsoftware.com/demos/webinars.aspx.
-----Original Message-----
From: techwr-l-bounces+david -dot- barber=ptgrey -dot- com -at- lists -dot- techwr-l -dot- com [mailto:techwr-l-bounces+david -dot- barber=ptgrey -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf Of Michael Herman (Parallelspace)
Sent: Thursday, March 04, 2010 9:53 AM
To: 'Keith Hood'; techwr-l -at- lists -dot- techwr-l -dot- com
Subject: RE: API doc question
There are specific s/w development tools like MS Visual Studio that can extract special API documentation comments from the source code of a software prodict (method names, parameter names, parameter datatypes, functional description/comments, etc.) and automatically generate online help for SDKs, etc. I think this is the most likely scenario the reviewer was referring to.
Michael Herman (Toronto)
-----Original Message-----
From: techwr-l-bounces+mwherman=parallelspace -dot- net -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+mwherman=parallelspace -dot- net -at- lists -dot- techwr-l -dot- com] On Behalf Of Keith Hood
Sent: Thursday, March 04, 2010 12:28 PM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: API doc question
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?
Obviously I didn't get the job. (I messed with API docs once, for about a year, and that was over 4 years ago.)
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 mwherman -at- parallelspace -dot- net -dot-
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 david -dot- barber -at- ptgrey -dot- com -dot-
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-
