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

Authors:
S. B. Ho;I. Chai;C. H. Tan
Affiliations:
Faculty of Information Technology, Multimedia University, Cyberjaya, Malaysia;Faculty of Engineering, Multimedia University, Cyberjaya, Malaysia;Faculty of Information Technology, Multimedia University, Cyberjaya, Malaysia
Venue:
Behaviour & Information Technology
Year:
2009

Citing 16
Cited 0

Software engineering (3rd ed.): a practitioner's approach

Software engineering (3rd ed.): a practitioner's approach
Documenting frameworks using patterns

OOPSLA '92 conference proceedings on Object-oriented programming systems, languages, and applications
An experimental evaluation of quality guidelines on the maintainability of object-oriented design documents

ESP '97 Papers presented at the seventh workshop on Empirical studies of programmers
Use Case Maps as Architectural Entities for Complex Systems

IEEE Transactions on Software Engineering
Frameworks and pattern languages: an intriguing relationship

ACM Computing Surveys (CSUR)
Software Engineering for Real-Time Systems

Software Engineering for Real-Time Systems
Practical Object-Oriented Design

Practical Object-Oriented Design
Two Controlled Experiments Assessing the Usefulness of Design Pattern Documentation in Program Maintenance

IEEE Transactions on Software Engineering
Software is different

Annals of Software Engineering
A Controlled Experiment in Maintenance Comparing Design Patterns to Simpler Solutions

IEEE Transactions on Software Engineering
Recovering Traceability Links between Code and Documentation

IEEE Transactions on Software Engineering
Defining the Problems of Framework Reuse

COMPSAC '02 Proceedings of the 26th International Computer Software and Applications Conference on Prolonging Software Life: Development and Redevelopment
Traceability Recovery in RAD Software Systems

IWPC '02 Proceedings of the 10th International Workshop on Program Comprehension
Software Documentation: How Much Is Enough?

CSMR '03 Proceedings of the Seventh European Conference on Software Maintenance and Reengineering
Designing electronic reference documentation for software component libraries

Journal of Systems and Software
Statistical significance testing: a panacea for software technology experiments?

Journal of Systems and Software - Special issue: Applications of statistics in software engineering

Quantified Score

Hi-index	0.00

Visualization

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 were actually better. This paper presents a novel way of investigating the different philosophies for framework documentation. The philosophies include minimalist, patterns-style and extended javadoc (Jdoc) documentation. Using a survey of 140 novices engaged in Swing intensive coding work, this empirical study discovered some guidelines for effective framework documentation for the Swing framework. The results suggest that different documentation is better for different goals.