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.
- Chikofsy, E.; and Cross, J. "Reverse Engineering and Design Recovery: A Taxonomy." IEEE Software 7(1):13--17, Jan. 1990. Google ScholarDigital Library
- 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. Google ScholarDigital Library
- Gamma, E.; Helm, R.; Johnson, J.; and Vlissides, J. Design Patterns: Elements of Reusable Object-Oriented Software. Reading, MA: Addison-Wesley, 1995. Google ScholarDigital Library
- 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. Google ScholarDigital Library
- 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. Google ScholarDigital Library
- IEEE P1471. "IEEE Recommended Practice for Architectural Description of Software-Intensive Systems." Standard 1471--2000.Google Scholar
- 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
- 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. Google ScholarDigital Library
- 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. Google ScholarDigital Library
- 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). Google ScholarDigital Library
- 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. Google ScholarDigital Library
- 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. Google ScholarDigital Library
- Tufte, E. Visual Explanations: Images and Quantities, Evidence and Narrative. Cheshire, CT: Graphics Press, 1997. Google ScholarDigital Library
Index Terms
- Documenting software systems with views VI: lessons learned from 15 years of research & practice
Recommendations
Manipulating and documenting software structures using SHriMP views
ICSM '95: Proceedings of the International Conference on Software MaintenanceAn 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 documentationDocumentation 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 documentationSoftware 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