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 use tools to extract (at the very least) the code
> prototypes from the
> code. This assures me of their accuracy. In some cases, I
> also extract code
> comment blocks. (I've been given permission to modify code comments.)
>
> Material about how to use the API is maintained separately.
> In other words,
> the sequence that code items should be created/called in, special
> techniques, etc.
>
Glen, what tools do you use to extract the code prototypes
and comment blocks?
I'm also working on documenting some APIs, and I'm feeling
a little out of my league. Can you provide some pointers on
"don't miss" information, so that I can make sure it gets in
my outline?
*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available now at http://www.devahelp.com or info -at- devahelp -dot- com
Sponsored by Information Mapping, Inc., a professional services firm
specializing in Knowledge Management and e-content solutions. See http://www.infomap.com or 800-463-6627 for more about our solutions.
---
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.
