Improving API documentation usability with knowledge pushing

Proceedings - International Conference on Software Engineering

Volumn , Issue , 2009, Pages 320-330

  Dekel, Uri ^a   Herbsleb, James D ^a  

^a Carnegie Mellon University   (United States)

Author keywords

[No Author keywords available]

Indexed keywords

API FUNCTIONS; DOCUMENTATION USABILITY; JAVADOC; METHOD INVOCATION; PLUG-INS; POTENTIAL BENEFITS;

COMPUTER SOFTWARE;

EID: 77949897678     PISSN: 02705257     EISSN: None     Source Type: Conference Proceeding    
DOI: 10.1109/ICSE.2009.5070532     Document Type: Conference Paper

References (13)

1. K. Bierhoff and J. Aldrich. Modular typestate checking of aliased objects. In OOPSLA '07, pages 301-320, New York, NY, USA, 2007. ACM.
2. U. Dekel. eMoose project page. http://emoose.cs.cmu.edu
3. U. Dekel and J. D. Herbsleb. Notation and representation in collaborative object-oriented design: an observational study. In OOPSLA '07, pages 261-280, New York, NY, USA, 2007. ACM.
4. A. J. Ko, H. Aung, and B. A. Myers. Eliciting design requirements for maintenance-oriented ides: a detailed study of corrective and perfective maintenance tasks. In ICSE '05, pages 126-135, 2005.
5. D. Kramer. Api documentation from source code comments: a case study of javadoc. In SIGDOC '99: Proceedings of the 17th annual international conference on Computer documentation, pages 147-153, New York, NY, USA, 1999. ACM.
6. G. T. Leavens, A. L. Baker, and C. Ruby. Preliminary design of JML: a behavioral interface specification language for java. SIGSOFT Softw. Eng. Notes, 31(3):1-38, 2006.
7. B. Meyer. Object-Oriented Software Construction. Prentice Hall, 2000.
8. A. Sarma, D. Redmiles, and A. van der Hoek. Empirical evidence of the benefits of workspace awareness in software configuration management. In FSE-16, pages 113-123, New York, NY, USA, 2008. ACM.
9. E. Soloway, R. Lampert, S. Letovsky, D. Littman, and J. Pinto. Designing documentation to compensate for delocalized plans. Commun. ACM, 31(11):1259-1267, 1988.
10. M.-A. Storey, L.-T. Cheng, I. Bull, and P. Rigby. Shared waypoints and social tagging to support collaboration in software development. In CSCW '06, pages 195-198, New York, NY, USA, 2006. ACM.
11. M.-A. Storey, J. Ryall, R. I. Bull, D. Myers, and J. Singer. Todo or to bug: exploring how task annotations play a role in the work practices of software developers. In ICSE '08, pages 251-260, New York, NY, USA, 2008. ACM.
12. Sun. Requirements for writing java api specifications.
13. L. Tan, D. Yuan, G. Krishna, and Y. Zhou. /*icomment: bugs or bad comments?*/. In SOSP '07: Proceedings of twenty-first ACM SIGOPS symposium on Operating systems principles, pages 145-158, New York, NY, USA, 2007. ACM.