Enhancing annotation visibility for software inspection

Annotation of software artifacts is common in software development, and vital for software inspection. People viewing annotated artifacts encounter delocalization: they must understand various parts of an artifact (and their annotations) to understand the part they are viewing. We taxonomize delocalization within software systems into lateral delocalization (different items of the artifact within the same development phase), longitudinal delocalization (related items in different phases), and historical delocalization (successive versions of the same item). We report on a pilot study of code inspection with AnnoSpec, an inspection tool supporting visibility of laterally-delocalized annotations. Our results suggest that addressing delocalization may help people perform inspections more effectively.

[1]  Jean-Pierre Corriveau,et al.  A Strategy for Realizing Traceability in an Object-Oriented Design Environment , 1994, CAST.

[2]  Elliot Soloway,et al.  Designing documentation to compensate for delocalized plans , 1988, CACM.

[3]  Michael A. Arbib,et al.  Annotation technology , 1999, Int. J. Hum. Comput. Stud..

[4]  Mark Guzdial,et al.  Whorf: a Hypertext Tool for Software Maintenance , 1994, Int. J. Softw. Eng. Knowl. Eng..

[5]  John Riedl,et al.  A general framework for interconnecting annotations of software systems , 1998, Proceedings. The Twenty-Second Annual International Computer Software and Applications Conference (Compsac '98) (Cat. No.98CB 36241).

[6]  Watts S. Humphrey,et al.  Managing the software process , 1989, The SEI series in software engineering.

[7]  Vahid Mashayekhi,et al.  A Case Study of Distributed, Asynchronous Software Inspection , 1997, Proceedings of the (19th) International Conference on Software Engineering.