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

Authors:
Scott Tilley
Affiliations:
Florida Institute of Technology, Melbourne, FL, USA
Venue:
Proceedings of the 27th ACM international conference on Design of communication
Year:
2009

Citing 11
Cited 1

Documenting software systems with views

SIGDOC '92 Proceedings of the 10th annual international conference on Systems documentation
Design patterns: elements of reusable object-oriented software

Design patterns: elements of reusable object-oriented software
Visual explanations: images and quantities, evidence and narrative

Visual explanations: images and quantities, evidence and narrative
Documenting software systems with views II: an integrated approach based on XML

SIGDOC '01 Proceedings of the 19th annual international conference on Computer documentation
Documenting software systems with views III: towards a task-oriented classification of program visualization techniques

Proceedings of the 20th annual international conference on Computer documentation
Reverse Engineering and Design Recovery: A Taxonomy

IEEE Software
Towards a documentation maturity model

Proceedings of the 21st annual international conference on Documentation
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 Documentation
Documenting software systems with views IV: documenting web transaction design with UWAT+

Proceedings of the 22nd annual international conference on Design of communication: The engineering of quality documentation
Documenting software systems with views V: towards visual documentation of design patterns as an aid to program understanding

SIGDOC '07 Proceedings of the 25th annual ACM international conference on Design of communication
7th international workshop on graphical documentation: documenting SOA-based systems

Proceedings of the 27th ACM international conference on Design of communication

A process practice to validate the quality of reused component documentation: a case study involving open-source components

Proceedings of the 2013 International Conference on Software and System Process

Quantified Score

Hi-index	0.00

Visualization

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.