The developer-documenter relationship in Java software development

Subscribe (Full Service)


	Search: The ACM Digital Library The Guide

	Feedback

The developer-documenter relationship in Java software development

Full text

Pdf (368 KB)

Source

ACM Special Interest Group for Design of Communication archive
Proceedings of the 17th annual international conference on Computer documentation table of contents

New Orleans, Louisiana, United States

Pages: 144 - 146

Year of Publication: 1999

ISBN:1-58113-072-4

Author

Glenn McAllister

IBM Canada, North York, Ont., Canada

Sponsor

SIGDOC: ACM Special Interest Group for Design of Communications

Publisher

ACM New York, NY, USA

Bibliometrics

Downloads (6 Weeks): 2, Downloads (12 Months): 11, Citation Count: 2

Additional Information:

abstract references cited by index terms

Tools and Actions:	Request Permissions Review this Article Save this Article to a Binder Display Formats: BibTeX EndNote ACM Ref

DOI Bookmark:	Use this link to bookmark this Article: http://doi.acm.org/10.1145/318372.318574 What is a DOI?

ABSTRACT

This paper describes the developer-documenter relationship in Java™ API software development. The lack of trust between developer and documenter is highlighted in the issue of updating doc comments in Java source code, and two potential solutions are presented. The first, long-term solution is to work to increase the levels of trust between developers and documenters. The second, short-term solution is to use a documentation tool that creates, modifies, or removes doc comments in a source file without changing the source code.

REFERENCES

Note: OCR errors may be found in this Reference List extracted from the full text article. ACM has opted to expose the complete List rather than only correct and linked references.

	1	Kramer, Doug. How to Write Dot Comments for Javadoc. http://java.sun.cornlproductsfjdkljavadoc/ writingdoccomments.html.
	2	Norman, Donald A. The Design of Everyday Things. Doubleday, New York, 1988

CITED BY 2

	Nizanne Kruithof, Developing user support systems in multidisciplinary teams - new opportunities, new challenges, Proceedings of IEEE professional communication society international professional communication conference and Proceedings of the 18th annual ACM international conference on Computer documentation: technology & teamwork, September 24-27, 2000, Cambridge, Massachusetts
	Anke Weber , Holger M. Kienle , Hausi A. Müller, Live documents with contextual, data-driven information components, Proceedings of the 20th annual international conference on Computer documentation, p.236-247, October 20-23, 2002, Toronto, Ontario, Canada