Article

Documenting software systems with views V: towards visual documentation of design patterns as an aid to program understanding

Authors:

Scott TilleyAuthors Info & Claims

SIGDOC '07: Proceedings of the 25th annual ACM international conference on Design of communication

Pages 103 - 112

https://doi.org/10.1145/1297144.1297167

Published: 22 October 2007 Publication History

Abstract

Cognitive science research indicates that a system is more readily understood when it is presented at progressive levels of decomposition, exposing increasing amounts of detail. One logical level of detail would present a system in terms of its implemented design patterns. However, to date, no entirely satisfactory method of documentation has been devised for explicating a software system as a set of design patterns. This paper discusses the challenges inherent in visualizing a software system as a set of design patterns, reviews the progress of another current effort, and describes a UML-compliant enhanced class-participation diagram as one possible solution.

References

[1]

Ambler, S. The Elements of UML 2.0 Style. New York, NY: Cambridge University Press, 2005.

Digital Library

[2]

Brown, W., Malveau, R., McCormick, H., and Mowbray, T. AntiPatterns: Refactoring Software, Architectures, and Projects in Crisis. New York: Wiley & Sons, 1998. pp. 7--8.

Digital Library

[3]

Chikofsy, E.; and Cross, J. "Reverse Engineering and Design Recovery: A Taxonomy." IEEE Software 7(1):13--17, January 1990.

Digital Library

[4]

Costagliola, G., De Lucia, A. Deufemia, V., Gravino, C. and Risi, M. "Case Studies of Visual Language Based Design Patterns Recovery" Proceedings of the Conference on Software Maintenance and Reengineering (CSMR'06) IEEE, 2006.

Digital Library

[5]

Eichelberger, H. "Nice Diagrams Admit Good Design?" In SoftVis '03: Proceedings of the 2003 Symposium on Software Visualization, pp. 159--168. New York: ACM Press, 2003.

Digital Library

[6]

Gamma, E and R. Helm, R. Johnson, J. Vlissides. Design Patterns: Elements of Reusable Object-Oriented Software. Reading, Mass: Addison-Wesley, 1995.

Digital Library

[7]

Gutwenger, C., Jünger, M., Klein, K., Kupke, J., Leipert, S. and Mutzel, P. "A New Approach for Visualizing UML class Diagrams." ACM Symposium on Software Visualization. San Diego, CA, 2003 pp. 179--188.

Digital Library

[8]

Huang, S. An Integrated Approach to Program Redocumentation. Ph.D. Dissertation, University of California, Riverside, 2004.

Digital Library

[9]

Kostelnick, C. and Roberts, D. Designing Visual Language: Strategies for Professional Communicators. Needham Heights, MA: Allyn & Bacon, 1998.

[10]

Mak, J., Choy, C., and Lun, D. "Precise Modeling of Design Patterns in UML." Proceedings of the 26th International Conference on Software Engineering (ICSE'04).

Digital Library

[11]

Prechelt, L.; B. Unger-Lamprecht; M. Philippsen; and W. Tichy. "Two Controlled Experiments Assessing the Usefulness of Design Pattern Documentation in Program Maintenance." IEEE Transactions on Software Engineering, Vol. 28, No. 6, June 2002. pp. 595--606.

Digital Library

[12]

Schauer, R. and Keller, R. "Pattern visualization for software comprehension." Proceedings of the 6th International Workshop on Program Comprehension (IWPC '98: June 24-26, 1998; Ischia, Italy), pp. 4--12. Los Alamitos, CA: IEEE Computer Society Press, 1998.

Digital Library

[13]

Sun, D. and Wong, K. "On Evaluating the Layout of UML Class Diagrams for Program Comprehension." Proceedings of the 13th International Workshop on Program Comprehension (IWPC 2005: May 15-16, 2006; St. Louis, MO), pp. 317--326. Los Alamitos, CA: IEEE Computer Society Press, 2005.

Digital Library

[14]

Tilley, S. and S. Huang. "A Qualitative Assessment of the Efficacy of UML Diagrams as a Form of Graphical Documentation in Aiding Program Understanding." Proceedings of the 21st Annual International Conference on Design of Communication (SIGDOC 2003: October 12-15, 2003; San Francisco, CA), pp. 184--191. ACM Press: New York, NY, 2003.

Digital Library

[15]

Tilley, S. and S. Huang. "Towards a Documentation Maturity Model." Proceedings of the 21st Annual International Conference on Design of Communication (SIGDOC 2003: October 12-15, 2003; San Francisco, CA), pp. 93--99. ACM Press: New York, NY, 2003.

Digital Library

[16]

Tufte, Edward R. Visual Explanations: Images and Quantities, Evidence and Narrative. Cheshire, CT: Graphics Press, 1997.

Digital Library

[17]

von Mayerhauser, A. and Vans, A. "Program Understanding during Large Scale Debugging of Software." Papers Presented at the Seventh Workshop on Empirical Studies of Programmers. New York: ACM Press, 1997. pp. 157--179.

Digital Library

Cited By

Zhi JGarousi-Yusifoğlu VSun BGarousi GShahnewaz SRuhe G(2015)Cost, benefits and quality of software development documentationJournal of Systems and Software10.1016/j.jss.2014.09.04299:C(175-198)Online publication date: 1-Jan-2015
https://dl.acm.org/doi/10.1016/j.jss.2014.09.042
Oduor MAlahäivälä TOinas-Kukkonen H(2014)Persuasive software design patterns for social influencePersonal and Ubiquitous Computing10.1007/s00779-014-0778-z18:7(1689-1704)Online publication date: 1-Oct-2014
https://dl.acm.org/doi/10.1007/s00779-014-0778-z
Tilley SMehlenbacher BProtopsaltis AWilliams ASlattery S(2009)Documenting software systems with views VIProceedings of the 27th ACM international conference on Design of communication10.1145/1621995.1622043(239-244)Online publication date: 5-Oct-2009
https://dl.acm.org/doi/10.1145/1621995.1622043
Show More Cited By

Index Terms

Documenting software systems with views V: towards visual documentation of design patterns as an aid to program understanding
1. Software and its engineering
  1. Software creation and management
    1. Software post-development issues
      1. Documentation

Recommendations

Documenting software systems with views
SIGDOC '92: Proceedings of the 10th annual international conference on Systems documentation

Software professionals rely on internal documentation as an aid in understanding programs. Unfortunately, the documentation for most programs is usually out-of-date and cannot be trusted. Without it, the only reliable and objective information is the ...
Documentation for software engineers: what is needed to aid system understanding?
SIGDOC '01: Proceedings of the 19th annual international conference on Computer documentation

Software engineers rely on program documentation as an aid in understanding the functional nature, high-level design, and implementation details of complex applications. However, no one really knows what types of documentation are truly useful to ...
Documenting software systems with views III: towards a task-oriented classification of program visualization techniques
SIGDOC '02: Proceedings of the 20th annual international conference on Computer documentation

Documentation has long played a key role in aiding program understanding. Graphical forms of documentation rely on software visualization techniques to make complicated information easier to understand. However, it is an open question exactly which ...

Comments

Information & Contributors

Information

Published In

cover image ACM Conferences

SIGDOC '07: Proceedings of the 25th annual ACM international conference on Design of communication

October 2007

286 pages

ISBN:9781595935885

DOI:10.1145/1297144

General Chair:
David Novick
The University of Texas at El Paso, TX
,
Program Chair:
Clay Spinuzzi
The University of Texas at Austin, TX

Copyright © 2007 ACM.

Permission to make digital or hard copies of all or part of this work for personal or classroom use is granted without fee provided that copies are not made or distributed for profit or commercial advantage and that copies bear this notice and the full citation on the first page. Copyrights for components of this work owned by others than ACM must be honored. Abstracting with credit is permitted. To copy otherwise, or republish, to post on servers or to redistribute to lists, requires prior specific permission and/or a fee. Request permissions from [email protected]

Sponsors

Publisher

Association for Computing Machinery

New York, NY, United States

Publication History

Published: 22 October 2007

Permissions

Request permissions for this article.

Request Permissions

Check for updates

Author Tags

Qualifiers

Article

Conference

SIGDOC07

Sponsor:

SIGDOC07: The 25th ACM International Conference on Design of Communication

October 22 - 24, 2007

Texas, El Paso, USA

Acceptance Rates

Overall Acceptance Rate 355 of 582 submissions, 61%

Contributors

Other Metrics

View Article Metrics

Bibliometrics & Citations

Bibliometrics

Article Metrics

4
Total Citations
View Citations
368
Total Downloads

Downloads (Last 12 months)2
Downloads (Last 6 weeks)0

Reflects downloads up to 01 Mar 2025

Other Metrics

View Author Metrics

Citations

Cited By

Zhi JGarousi-Yusifoğlu VSun BGarousi GShahnewaz SRuhe G(2015)Cost, benefits and quality of software development documentationJournal of Systems and Software10.1016/j.jss.2014.09.04299:C(175-198)Online publication date: 1-Jan-2015
https://dl.acm.org/doi/10.1016/j.jss.2014.09.042
Oduor MAlahäivälä TOinas-Kukkonen H(2014)Persuasive software design patterns for social influencePersonal and Ubiquitous Computing10.1007/s00779-014-0778-z18:7(1689-1704)Online publication date: 1-Oct-2014
https://dl.acm.org/doi/10.1007/s00779-014-0778-z
Tilley SMehlenbacher BProtopsaltis AWilliams ASlattery S(2009)Documenting software systems with views VIProceedings of the 27th ACM international conference on Design of communication10.1145/1621995.1622043(239-244)Online publication date: 5-Oct-2009
https://dl.acm.org/doi/10.1145/1621995.1622043
Storey MBennett CBull RGerman D(2008)Remixing visualization to support collaboration in software maintenance2008 Frontiers of Software Maintenance10.1109/FOSM.2008.4659257(139-148)Online publication date: Sep-2008
https://doi.org/10.1109/FOSM.2008.4659257

View Options

Login options

Check if you have access through your login credentials or your institution to get full access on this article.

Full Access

Get this Publication

View options

PDF

View or Download as a PDF file.

eReader

View online with eReader.

Figures

Tables

Media

View Table of Conten