Abstract
Frameworks are increasingly employed as a useful way to enable object-oriented reuse. However, understanding frameworks is not easy due to their size and complexity. Previous work concentrated on different ways to document frameworks, but it was unclear which ones actually were better. This paper presents results in investigating the different philosophies for framework documentation. The philosophies include minimalist, patterns-style and extended javadoc (Jdoc) documentation. Using a survey of 90 intermediate undergraduates engaged in Command and Adaptor design patterns coding work, this exploratory study discovered that minimalist documentation has positive impact in encouraging knowledge acquisition, significantly in terms of the framework functional workings. This concludes that documentation solutions with the minimalist principle can lead intermediate undergraduates to faster growth in learning two of the design patterns.
International Conference on Data Engineering (DaEng), p. 1-8, 2013.
This is a preview of subscription content, log in via an institution to check access.
Access this chapter
Tax calculation will be finalised at checkout
Purchases are for personal use only
Preview
Unable to display preview. Download preview PDF.
References
Martin, R.C., Newkirk, J.W., Koss, R.S.: Agile Software Development: Principles, Patterns, and Practices. Pearson Education Int’l, Upper Saddle River, NJ, pp. 13, pp. 43-84 (2012)
Carroll, J.M.: Minimalism beyond the Nurnberg Funnel. MIT Press, Cambridge, MA (1998)
Chai, I.: Pedagogical framework documentation: how to document object-oriented frameworks: an empirical study. PhD dissertation, University of Illinois at Urbana-Champaign, IL, http://www.cs.uiuc.edu/research/techreports.php?report=UIUCDCS-R-99-2077 (2000)
Johnson, R.: Documenting frameworks using patterns. In: Proc. ACM Object-Oriented Programming, Systems, Languages and Applications (OOPSLA’92), pp. 63-76. ACM Press, Vancouver, British Columbia, Canada (October 1992)
Berglund, E.: Designing electronic reference documentation for software component libraries. J. Systems and Software, vol. 68, no. 1, 65-75 (2003)
Cockburn, A.: Supporting tailorable program visualisation through literate programming and fisheye views. J. Information and Software Technology, vol. 43, no. 13, 745-758 (2001)
Gamma, E., Helm, R., Johnson, R., Vlissides, J.: Design Patterns: Elements of Reusable Object-Oriented Software. Pearson Addison-Wesley, Reading, MA (1994) [Commonly called the “Gang of Four” or “GoF” book]
Ho, S.B., Chai, I., Tan, C.H.: Comparison of different documentation styles for frameworks of object-oriented code. Behaviour and Information Technology, vol. 28, no. 3, 201-210 (2009)
Ho, S.B., Chai, I., Tan, C.H.: An empirical investigation of methods for teaching design patterns within object-oriented frameworks. International Journal of Information Technology and Decision Making, vol. 6, no. 4, 701-722 (2007)
Example of the documentation fragment which was presented in all the three documentation groups, http://pesona.mmu.edu.my/~sbho/Swing/Jdoc/t10jDoc/302greetAct.html
Example of the documentation fragment that is available in the patterns style documentation, but not available in the minimalist and Jdoc documentation, http://pesona.mmu.edu.my/~sbho/Swing/Composite/t12Pat/302greetAct.html
Example of the documentation fragment that is available in the Jdoc documentation, but not available in the minimalist and patterns style documentation, http://pesona.mmu.edu.my/~sbho/Swing/Pattern/t10Pat/GreetingAction.html
Beizer, B.: Software is different. In: Patel, D., Wang, Y. (eds.) Comparative Studies of Engineering Approaches for Software Engineering, vol. 10, pp. 293-310. Baltzer Science Publishers, Norwell, MA (2000)
Neter, J., Kutner, M.H., Nachtsheim, C.J., Wasserman, W.: Applied Linear Statistical Models. McGraw Hill, Boston, MA (1996)
Field, A.: Discovering Statistics Using SPSS, 3rd ed. SAGE Publications Ltd, London, pp. 560-567 (2011)
Pressman, R.S.: Software Engineering: A Practitioner’s Approach, 7th ed. McGraw Hill, New York, pp. 347-354, pp. 835-837 (2010)
Author information
Authors and Affiliations
Corresponding author
Editor information
Editors and Affiliations
Rights and permissions
Copyright information
© 2014 Springer Science+Business Media Singapore
About this paper
Cite this paper
Ho, SB., Chai, I., Tan, CH. (2014). A Comparison of Three Documentation Styles for Educational Data Analysis. In: Herawan, T., Deris, M., Abawajy, J. (eds) Proceedings of the First International Conference on Advanced Data and Information Engineering (DaEng-2013). Lecture Notes in Electrical Engineering, vol 285. Springer, Singapore. https://doi.org/10.1007/978-981-4585-18-7_79
Download citation
DOI: https://doi.org/10.1007/978-981-4585-18-7_79
Published:
Publisher Name: Springer, Singapore
Print ISBN: 978-981-4585-17-0
Online ISBN: 978-981-4585-18-7
eBook Packages: EngineeringEngineering (R0)