API documentation process series, Creating Javadoc API documentation with indirectly updated source

A bridge between writer and developer

From the developerWorks archives

Mariana Alupului, David Steinmetz, and Janis Steinfeld

Date archived: December 19, 2016 | First published: April 25, 2006

The process described in this article is the result of discussions and experimentation by development and documentation teams. These teams recognized that quality application programming interface (API) reference documentation must be a collaboration between the developers and the writers. In addition, the teams sought to have all documentation updates be reflected back into the source code and to have daily Javadoc builds for internal customers include updated documentation. The teams wanted a process that was efficient and reduced duplication of effort.

This content is no longer being updated or maintained. The full article is provided "as is" in a PDF file. Given the rapid evolution of technology, some steps and illustrations may have changed.



static.content.url=http://www.ibm.com/developerworks/js/artrating/
SITE_ID=1
Zone=Java development, Rational
ArticleID=109138
ArticleTitle=API documentation process series: Creating Javadoc API documentation with indirectly updated source
publish-date=04252006