This Article 
   
 Share 
   
 Bibliographic References 
   
 Add to: 
 
Digg
Furl
Spurl
Blink
Simpy
Google
Del.icio.us
Y!MyWeb
 
 Search 
   
Incremental Redocumentation Using the Web
September/October 2000 (vol. 17 no. 5)
pp. 102-106
Too often, a company takes over someone else's software only to find that documentation is sadly lacking. This report shows how one small software company used the Web-based Partitioned Annotations to cost-effectively evolve a software application it had inherited.

1. R.K. Fjeldstad and W.T. Hamlen, "Application Program Maintenance Study: Report to Our Respondents," Tutorial on Software Maintenance, IEEE Computer Soc. Press, Los Alamitos, Calif., 1982, pp. 13-30.
2. I.T. Bowman and R.C. Holt, "Reconstructing Ownership Architectures to Help Understand Software Systems," Proc. Seventh Int'l Workshop Program Comprehension, IEEE CS Press, 1999, pp. 28-37.
3. A.V. Mayrhauser and A. Vans, “On the Role of Hypotheses During Opportunistic Understanding while Porting Large Scale Code,” Proc. Fourth Workshop Program Comprehension., pp. 68–77, Mar. 1996.
4. M.D. Storey, F.D. Fracchia, and H.A. Muller, “Cognitive Design Elements to Support the Construction of a Mental Model During Software Visualization,” Proc. Fifth Int'l Workshop Program Comprehension (IWPC'97), pp. 17-28, Mar. 1997.
5. V. Rajlich and S. Varadajan, "Using the Web for Software Annotations," Int'l J. Software Eng. and Knowledge Eng., Vol. 9, No. 1, 1999, pp. 55-72.
6. A. Lakhotia, "Understanding Someone Else's Code: An Analysis of Experience," J. Systems and Software, Vol. 23, 1993, pp. 269-275.
1. M.R. Olsem, "An Incremental Approach to Software Systems Re-engineering," Software Maintenance: Research and Practice, Vol. 10, No. 3, May/June 1998, pp. 181-202.
2. J. Bigelow, "Hypertext and CASE," IEEE Software, Vol. 7, No. 2, Mar. 1988, pp. 23-27
3. N. Fletton and M. Munroe, "Redocumenting Software Systems Using Hypertext Technologies," Proc. IEEE Conf. Software Maintenance, IEEE Computer Soc. Press, Los Alamitos, Calif., 1988, pp. 54-59
4. E. Horowitz and R. Williamson, "SODOS: A Software Documentation Support Environment—Its Use," IEEE Trans. Software Eng., Nov. 1986, pp. 1076-1087.
5. E.J. Younger and K.H. Bennett, "Model-Based Tools to Record Program Understanding," Proc. IEEE Workshop Program Comprehension, IEEE Computer Soc. Press, Los Alamitos, Calif., 1993, pp. 87-95.
6. V. Rajlich, J. Doran, and R.T.S. Gudla, "Layered Explanations of Software: A Methodology for Program Comprehension," Third Workshop on Program Comprehension, WPC'93,Washington, D.C., pp. 46-52, Nov. 1994.
7. V. Rajlich and S.R. Adnapaly, "VIFOR 2: A Tool for Browsing and Documentation," Proc. IEEE Int'l Conf. Software Maintenance, IEEE Computer Soc. Press, Los Alamitos, Calif., 1996, pp. 296-300.
8. G. Kaiser, S. Dossick, W. Jiang, and J. Yang,“An Architecture for WWW-Based Hypercode Environments,” Proc. 19th Int'l Conf. Software Eng. (ICSE), pp. 3–13, Boston, May 1997.
9. H.A. Müller and K. Klashinsky, “A System for Programming-in-the-Large,” Proc. 10th Int'l Conf. Software Eng., pp. 80–86, Apr. 1988.
10. V. Rajlich et al., Visual Support for Programming-in-the-Large, Proc. IEEE Conf. Software Maintenance, IEEE Computer Soc. Press, 1988, 92-99.
11. A. van Deursen and T. Kuipers, "Building Documentation Generators," Proc. Int'l Conf. Software Maintenance, IEEE Computer Soc. Press, Los Alamitos, Calif., 1999, pp. 40-49.

Citation:
Václav Rajlich, "Incremental Redocumentation Using the Web," IEEE Software, vol. 17, no. 5, pp. 102-106, Sept.-Oct. 2000, doi:10.1109/52.877875
Usage of this product signifies your acceptance of the Terms of Use.