RE: API Writers?

["Matt Horn" <mhorn -at- macromedia -dot- com>]

> Rajeev Jain wrote:
> Do we have any API writers subscribed to this list? If yes, I 
> would like them to share their experiences with developers, 
> management, tools used, and also about their contribution in 
> the content (of API Guides and Programmers Manuals).

That's a pretty broad request. Can you perhaps narrow it a bit? In the
meantime, I'll respond with an equally broad answer. :)

Developers: I work with them on figuring out what stuff does.

Managers: I work with them on figuring when stuff is done and by whom.

Tools Used: To create or edit API doc, I use TextPad or whatever text
editor. We edit the class files and embed API comments in there. We then
use a local ant build to test our changes (make sure we didn't break it,
basically) and another internal tool to generate JavaDoc-like output for
the class libraries. 

Here is an example of the API doc output:
http://livedocs.macromedia.com/flex/15/asdocs_en/mx/containers/Accordion
.html

Contribution to API Guides and Programmer's Manuals: Yes.

Matthew Horn
Sr. Technical Writer
< m a c r o m e d i a >

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

New from Quadralay Corporation: WebWorks ePublisher Pro! Easily create
14 online formats, including 6 Help systems, in a project-based
workflow. Live, online demo! http://www.webworks.com/techwr-l

Doc-To-Help 2005 now has RoboHelp Converter and HTML Source: Author
content and configure Help in MS Word or any HTML editor. No
proprietary editor! *August release. http://www.componentone.com/TECHWRL/DocToHelp2005

---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot-  Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.