research-article

Documenting software systems with views VI: lessons learned from 15 years of research & practice

Author:

Scott TilleyAuthors Info & Claims

SIGDOC '09: Proceedings of the 27th ACM international conference on Design of communication

Pages 239 - 244

https://doi.org/10.1145/1621995.1622043

Published: 05 October 2009 Publication History

Get Access

Abstract

A "view" is a form of graphical documentation representing some aspect of a software system. Views can be an important aid in helping to understand large-scale applications, and can be automatically produced through reverse engineering. This paper summarizes our findings and lessons learned related to documenting software systems with views from numerous projects spanning 15 years of research and practice (1992-2007). These findings have continued relevancy for modern software development and technical communication alike.

References

[1]

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

Digital Library

Google Scholar

[2]

Distante, D.; Tilley, S.; and Huang, S. "Documenting Software Systems with Views IV: Documenting Web Transaction Design with UWAT+." Proceedings of the 22nd International Conference on Design of Communication (SIGDOC 2004: October 10--13, 2004; Memphis, TN), pp. 33--40. ACM Press: New York, NY, 2004.

Digital Library

Google Scholar

[3]

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

Digital Library

Google Scholar

[4]

Hartmann, J.; Huang, S.; and Tilley, S. "Documenting Software Systems with Views II: An Integrated Approach Based on XML." Proceedings of the 19th Annual International Conference on Systems Documentation (SIGDOC 2001: Santa Fe, NM; October 21--24, 2001), pp. 237--246. ACM Press: New York, NY, 2001.

Digital Library

Google Scholar

[5]

Huang, S. and Tilley, S. "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

Google Scholar

[6]

IEEE P1471. "IEEE Recommended Practice for Architectural Description of Software-Intensive Systems." Standard 1471--2000.

Google Scholar

[7]

Kienle H.; and Müller, H. "The Rigi Reverse Engineering Environment." Proceedings of the International Workshop on Advanced Software Development Tools and Techniques (WASDeTT 2008: July 8, 2008; Paphos, Cyprus). Co-Located with ECOOP 2008.

Google Scholar

[8]

Tilley, S and Huang, S. "Documenting Software Systems with Views III: Towards a Task-Oriented Classification of Program Visualization Techniques". Proceedings of the 20th Annual International Conference on Systems Documentation (SIGDOC 2002: October 20--23, 2002; Toronto, Canada), pp. 226--233. ACM Press: New York, NY, 2002.

Digital Library

Google Scholar

[9]

Tilley, S. and Huang, S. "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

Google Scholar

[10]

Tilley, S.; and Bellomo, S. "7th International Workshop on Graphical Documentation: Documenting SOA--Based Systems." To be held as part of the 27th ACM International Conference on Design of Communication (SIGDOC 2009: Oct. 5--7, 2009; Bloomington, IN).

Digital Library

Google Scholar

[11]

Tilley, S.; Müller, H.; and Orgun, M. "Documenting Software Systems with Views." Proceedings of the 10th Annual International Conference on Systems Documentation (SIGDOC '92: Ottawa, ON; October 13--16, 1992), pp. 211--219. New York, NY: Association for Computing Machinery, 1992.

Digital Library

Google Scholar

[12]

Trese, T. and Tilley, S. "Documenting Software Systems with Views V: Towards Visual Documentation of Design Patterns as an Aid to Program Understanding." Proceedings of the 25th ACM International Conference on Design of Communication (SIGDOC 2007: Oct. 22--24, 2007; El Paso, TX), pp. 103--112. ACM Press: New York, NY, 2007.

Digital Library

Google Scholar

[13]

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

Digital Library

Google Scholar

Cited By

View all

Haider SKhalil WAl-Shamayleh AAkhunzada AGani A(2023)Risk Factors and Practices for the Development of Open Source Software From Developers’ PerspectiveIEEE Access10.1109/ACCESS.2023.326704811(63333-63350)Online publication date: 2023
https://doi.org/10.1109/ACCESS.2023.3267048
Mendivelso LGarcés KCasallas R(2018)Metric-centered and technology-independent architectural views for software comprehensionJournal of Software Engineering Research and Development10.1186/s40411-018-0060-66:1Online publication date: 4-Dec-2018
https://doi.org/10.1186/s40411-018-0060-6
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
Show More Cited By

Index Terms

Documenting software systems with views VI: lessons learned from 15 years of research & practice
1. Social and professional topics
  1. Professional topics
    1. Management of computing and information systems
      1. Software management
        Software maintenance
2. Software and its engineering
  1. Software creation and management
    1. Software post-development issues

Recommendations

Manipulating and documenting software structures using SHriMP views
ICSM '95: Proceedings of the International Conference on Software Maintenance

An effective approach to program understanding involves browsing, exploring, and creating views that document software structures at different levels of abstraction. While exploring the myriad of relationships in a multi-million line legacy system, one ...
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 ...
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 ...

Comments

Information & Contributors

Information

Published In

SIGDOC '09: Proceedings of the 27th ACM international conference on Design of communication

October 2009

328 pages

ISBN:9781605585598

DOI:10.1145/1621995

General Chairs:
Brad Mehlenbacher
North Carolina State University, USA
,
Aristidis Protopsaltis
University of Reading, UK
,
Program Chairs:
Ashley Williams
Bridgeline Software, USA
,
Shaun Slattery
DePaul University, USA

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]

Publisher

Association for Computing Machinery

New York, NY, United States

Publication History

Published: 05 October 2009

Permissions

Request permissions for this article.

Request Permissions

Check for updates

Author Tags

Qualifiers

Research-article

Conference

SIGDOC '09

Sponsor:

SIGDOC '09: The 27th ACM International Conference on Design of Communication

October 5 - 7, 2009

Indiana, Bloomington, USA

Acceptance Rates

Overall Acceptance Rate 355 of 582 submissions, 61%

Contributors

Other Metrics

View Article Metrics

Bibliometrics & Citations

Bibliometrics

Article Metrics

5
Total Citations
View Citations
221
Total Downloads

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

Reflects downloads up to 09 Jan 2025

Other Metrics

View Author Metrics

Citations

Cited By

View all

Haider SKhalil WAl-Shamayleh AAkhunzada AGani A(2023)Risk Factors and Practices for the Development of Open Source Software From Developers’ PerspectiveIEEE Access10.1109/ACCESS.2023.326704811(63333-63350)Online publication date: 2023
https://doi.org/10.1109/ACCESS.2023.3267048
Mendivelso LGarcés KCasallas R(2018)Metric-centered and technology-independent architectural views for software comprehensionJournal of Software Engineering Research and Development10.1186/s40411-018-0060-66:1Online publication date: 4-Dec-2018
https://doi.org/10.1186/s40411-018-0060-6
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
Gendreau ORobillard PMünch JLan JZhang H(2013)A process practice to validate the quality of reused component documentation: a case study involving open-source componentsProceedings of the 2013 International Conference on Software and System Process10.1145/2486046.2486059(61-69)Online publication date: 18-May-2013
https://dl.acm.org/doi/10.1145/2486046.2486059
Tilley S(2012)8^th international workshop on graphical documentation: SOA-based systems2012 IEEE International Professional Communication Conference10.1109/IPCC.2012.6408641(1-2)Online publication date: Oct-2012
https://doi.org/10.1109/IPCC.2012.6408641

View Options

Login options

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

Cited By

Index Terms

Recommendations

Manipulating and documenting software structures using SHriMP views

Documenting software systems with views III: towards a task-oriented classification of program visualization techniques

Documenting software systems with views