A Comparison of Three Documentation Styles for Educational Data Analysis

Conference paper
Part of the Lecture Notes in Electrical Engineering book series (LNEE, volume 285)


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.


Educational Data Analysis Learning Analytics Knowledge Management Empirical Research Result Knowledge Surveying Work 


Unable to display preview. Download preview PDF.

Unable to display preview. Download preview PDF.


  1. 1.
    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)Google Scholar
  2. 2.
    Carroll, J.M.: Minimalism beyond the Nurnberg Funnel. MIT Press, Cambridge, MA (1998)Google Scholar
  3. 3.
    Chai, I.: Pedagogical framework documentation: how to document object-oriented frameworks: an empirical study. PhD dissertation, University of Illinois at Urbana-Champaign, IL, (2000)
  4. 4.
    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)Google Scholar
  5. 5.
    Berglund, E.: Designing electronic reference documentation for software component libraries. J. Systems and Software, vol. 68, no. 1, 65-75 (2003)Google Scholar
  6. 6.
    Cockburn, A.: Supporting tailorable program visualisation through literate programming and fisheye views. J. Information and Software Technology, vol. 43, no. 13, 745-758 (2001)Google Scholar
  7. 7.
    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]Google Scholar
  8. 8.
    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)Google Scholar
  9. 9.
    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)Google Scholar
  10. 10.
    Example of the documentation fragment which was presented in all the three documentation groups,
  11. 11.
    Example of the documentation fragment that is available in the patterns style documentation, but not available in the minimalist and Jdoc documentation,
  12. 12.
    Example of the documentation fragment that is available in the Jdoc documentation, but not available in the minimalist and patterns style documentation,
  13. 13.
    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)Google Scholar
  14. 14.
    Neter, J., Kutner, M.H., Nachtsheim, C.J., Wasserman, W.: Applied Linear Statistical Models. McGraw Hill, Boston, MA (1996)Google Scholar
  15. 15.
    Field, A.: Discovering Statistics Using SPSS, 3rd ed. SAGE Publications Ltd, London, pp. 560-567 (2011)Google Scholar
  16. 16.
    Pressman, R.S.: Software Engineering: A Practitioner’s Approach, 7th ed. McGraw Hill, New York, pp. 347-354, pp. 835-837 (2010)Google Scholar

Copyright information

© Springer Science+Business Media Singapore 2014

Authors and Affiliations

  1. 1.Faculty of Computing and InformaticsMultimedia UniversityCyberjayaMalaysia
  2. 2.Faculty of EngineeringMultimedia UniversityCyberjayaMalaysia
  3. 3.Faculty of ManagementMultimedia UniversityCyberjayaMalaysia

Personalised recommendations