RE: API doc question

Subject: RE: API doc question
From: "Michael Herman \(Parallelspace\)" <mwherman -at- parallelspace -dot- net>
To: "'Keith Hood'" <klhra -at- yahoo -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 4 Mar 2010 12:53:17 -0500

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-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit
http://lists.techwr-l.com/mailman/options/techwr-l/mwherman%40parallelspace.
net


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/ for more resources and info.

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/ for more resources and info.

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat


Follow-Ups:

References:
RE: Profanity in the workplace (Dan Goldstein): From: Paul Moloney
API doc question: From: Keith Hood

Previous by Author: Re: Pleasurable typo
Next by Author: "Labs" vs. "Tutorials"?
Previous by Thread: Re: API doc question
Next by Thread: RE: API doc question


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads