164
Views
3
CrossRef citations to date
0
Altmetric
Object-oriented technology and usability

Comparison of different documentation styles for frameworks of object-oriented code

, &
Pages 201-210 | Accepted 01 Nov 2006, Published online: 23 Apr 2009

References

  • Antoniol , G. , Canfora , G. and Casazza , G. 2002 . Recovering traceability links between code and documentation . IEEE Transactions on Software Engineering , 28 : 970 – 983 .
  • Beizer , B. 2000 . “ Software is different ” . In Comparative studies of engineering approaches for software engineering, annals of software engineering , Edited by: Patel , D. and Wang , Y. Vol. 10 , 293 – 310 . Norwell, MA : Baltzer Science Publishers .
  • Berglund , E. 2003 . Designing electronic reference documentation for software component libraries . Journal of Systems and Software , 68 : 65 – 75 .
  • Bluman , A. G. 2004 . Elementary statistics: a step by step approach , New York : McGraw-Hill International Edition .
  • Briand , L. C. . Software documentation: how much is enough? . IEEE proceedings of 7th European conference on software maintenance and reengineering (CSMR '03) . March 26–28 2003 . pp. 13 – 15 . Benevento, , Italy : IEEE Computer Society .
  • Briand , L. C. , Bunse , C. and Daly , J. W. . An experimental evaluation of quality guidelines on the maintainability of object-oriented design documents . ACM proceedings of 7th workshop on empirical studies of programmers . October 1–3 1997 . pp. 1 – 19 . Alexandria, VA : ACM Press .
  • Brugali , D. and Sycara , K. 2000 . Frameworks and pattern languages: an intriguing relationship . ACM Computing Surveys (SUR) , 32 : 2 – 7 .
  • Buhr , R. J.A. 1998 . Use case maps as architectural entities for complex systems . IEEE Transactions on Software Engineering , 24 : 1131 – 1155 .
  • Carroll , J. M. 1998 . Minimalism beyond the Nurnberg Funnel , Cambridge, MA : MIT Press .
  • Chai , I. 2000 . “ Pedagogical framework documentation: how to document object-oriented frameworks: an empirical study ” . PhD dissertation, University of Illinois at Urbana-Champaign, IL. Available from: http://www. cs.uiuc.edu/research/techreports.php?report=UIUCDCS- R-99-2077 [Accessed 5 March 2006]
  • Cockburn , A. 2001 . Supporting tailorable program visualisation through literate programming and fisheye views . Information and Software Technology , 43 : 745 – 758 .
  • Cooling , J. 2003 . Software engineering for real time systems , Harlow, , Essex : Pearson Education Limited .
  • Endres , A. and Rombach , D. 2003 . A handbook of software and systems engineering , London : Pearson Education Limited .
  • Fayad , M. E. , Schmidt , D. C. and Johnson , R. E. 1999 . “ Application frameworks ” . In Domain-specific application frameworks: problems and perspective , Edited by: Fayad , M. E. , Schmidt , D. C. and Johnson , R. E. 3 – 27 . New York : John Wiley and Sons .
  • Galin , D. 2004 . Software quality assurance: from theory to implementation , London : Pearson Education Limited .
  • Graff , M. 2005 . Individual differences in hypertext browsing strategies . Behaviour & Information Technology , 24 : 93 – 99 .
  • Ho , S. B. , Chai , I. and Tan , C. H. . An empirical investigation for different sequence of pedagogical framework documentation for RAD . Proceedings of 8th IASTED international conference on software engineering and applications (SEA 2004) . November 9–11 2004 . pp. 253 – 258 . Cambridge, MA : ACTA Press .
  • Johnson , R. . Documenting frameworks using patterns . Proceedings of ACM object-oriented programming, systems, languages and applications (OOPSLA'92) . October 1992 .
  • Kirk , D. , Roper , M. and Wood , M. . Defining the problems of framework reuse . Proceedings of 26th IEEE international computer software and applications conference (COMPSAC '02) . August 26–29 2002 . pp. 623 – 626 . Oxford, , England : IEEE Computer Society .
  • Miller , J. 2004 . Statistical significance testing—a panacea for software technology experiments? . Journal of Systems and Software , 73 : 183 – 192 .
  • Neter , J. 1996 . Applied linear statistical models , Boston, MA : McGraw Hill .
  • Parush , A. 2004 . An empirical evaluation of textual display configurations for supervisory tasks . Behaviour & Information Technology , 23 : 225 – 235 .
  • Penta , M. D. , Gradara , S. and Antoniol , G. . Traceability recovery in RAD software systems . IEEE proceedings of 10th international workshop on program comprehension . June 27–29 2002 . pp. 207 – 216 . Paris, , France : IEEE Computer Society .
  • Prechelt , L. 2001 . A controlled experiment in maintenance comparing design patterns to simpler solutions . IEEE Transactions on Software Engineering , 27 : 1134 – 1144 .
  • Prechelt , L. 2002 . Two controlled experiments assessing the usefulness of design pattern information during program maintenance . IEEE Transactions on Software Engineering , 28 : 595 – 606 .
  • Pressman , R. S. 2005 . Software engineering: a practitioner's approach , 6th ed. , New York : McGrawHill .
  • Priestley , M. 2004 . Practical object-oriented design with UML , New York : McGrawHill .
  • Sun Microsystems, Inc. 2006 . Sun Developer Network (SDN) . Java SE at a glance , Available from: http://java.sun.com/javase/
  • Swing . 2004a . Example from the minimalist documentation: How to display a simple frame for Swing GUI Available from: http://pesona.mmu.edu.my/∼sbho/Swing/Minimal/t10Min/002mainExt.htm
  • Swing . 2004b . Example from the patterns style documentation: How to display a simple frame for Swing GUI Available from: http://pesona.mmu.edu.my/∼sbho/Swing/Pattern/t10Pat/002 mainExt.htm
  • Swing . 2004c . Example from the Jdoc documentation: Class Painter Available from: http://pesona.mmu.edu.my/∼sbho/Swing/Jdoc/t10jDoc/Painter.html
  • Swing . 2006 . Items from the exercise on the Swing experiment . Available from: http://pesona.mmu.edu.my/∼sbho/Swing/ bit/exercise.htm

Reprints and Corporate Permissions

Please note: Selecting permissions does not provide access to the full text of the article, please see our help page How do I view content?

To request a reprint or corporate permissions for this article, please click on the relevant link below:

Academic Permissions

Please note: Selecting permissions does not provide access to the full text of the article, please see our help page How do I view content?

Obtain permissions instantly via Rightslink by clicking on the button below:

If you are unable to obtain permissions via Rightslink, please complete and submit this Permissions form. For more information, please visit our Permissions help page.