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

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.

[1]  Shihong Huang,et al.  A qualitative assessment of the efficacy of UML diagrams as a form of graphical documentation in aiding program understanding , 2003, SIGDOC '03.

[2]  James H. Cross,et al.  Reverse engineering and design recovery: a taxonomy , 1990, IEEE Software.

[3]  Shihong Huang,et al.  Documenting software systems with views III: towards a task-oriented classification of program visualization techniques , 2002, SIGDOC '02.

[4]  Shihong Huang,et al.  Towards a documentation maturity model , 2003, SIGDOC '03.

[5]  Shihong Huang,et al.  Documenting software systems with views II: an integrated approach based on XML , 2001, SIGDOC '01.

[6]  Hausi A. Müller,et al.  The Rigi Reverse Engineering Environment , 2008 .

[7]  IEEE-SA Standards Board , 2000 .

[8]  Stephany Bellomo,et al.  7th international workshop on graphical documentation: documenting SOA-based systems , 2009, SIGDOC '09.

[9]  Shihong Huang,et al.  Documenting software systems with views IV: documenting web transaction design with UWAT+ , 2004, SIGDOC '04.

[10]  Scott R. Tilley,et al.  Documenting software systems with views V: towards visual documentation of design patterns as an aid to program understanding , 2007, SIGDOC '07.

[11]  Hausi A. Müller,et al.  Documenting software systems with views , 1992, SIGDOC '92.

[12]  Ralph Johnson,et al.  design patterns elements of reusable object oriented software , 2019 .

[13]  H. Margolis.  Visual explanations: Images and quantities, evidence and narrative , 1998 .