Incremental Redocumentation Using the Web

Rajlich, Václav

doi:10.1109/52.877875

Cited by 14 publications

(7 citation statements)

References 16 publications

Supporting

Mentioning

Contrasting

Order By: Relevance

“…• Rajlich [20] proposes a re-documentation tool that allows to gather the following information: notes on the application domain, dependencies among classes, detailed description of a class' methods.…”

Section: Documentation For Maintenancementioning

confidence: 99%

A study of the documentation essential to software maintenance

Souza

Anquetil

Oliveira

2005

Proceedings of the 23rd Annual International Conference on Design of Communication: Documenting &Amp; Designing for Pervasive I

221

100

View full text Add to dashboard Cite

Software engineering has been striving for years to improve the practice of software development and maintenance. Documentation has long been prominent on the list of recommended practices to improve development and help maintenance. Recently however, agile methods started to shake this view, arguing that the goal of the game is to produce software and that documentation is only useful as long as it helps to reach this goal.On the other hand, in the re-engineering field, people wish they could re-document useful legacy software so that they may continue maintain them or migrate them to new platform.In these two case, a crucial question arises: "How much documentation is enough?" In this article, we present the results of a survey of software maintainers to try to establish what documentation artifacts are the most useful to them.

show abstract

Section: Documentation For Maintenancementioning

confidence: 99%

A study of the documentation essential to software maintenance

Souza

Anquetil

Oliveira

2005

Proceedings of the 23rd Annual International Conference on Design of Communication: Documenting &Amp; Designing for Pervasive I

221

100

View full text Add to dashboard Cite

show abstract

“…One of the common issues in maintaining the system is to record the changes requested by customer or user occurring in the source code. Rajlich [15] used the incremental redocumentation approach to solve this problem and recorded in the skeleton software documentation. But the abstractions are in the low level and not used by any standard documentation.…”

Section: Outputmentioning

confidence: 99%

A Software Redocumentation Process Using Ontology Based Approach in Software Maintenance

Nallusamy¹

2011

IJIEE

View full text Add to dashboard Cite

Abstract-This paper describes a framework to redocumenting legacy source codes and other related software components to support the software maintenance. The framework generates the ontology to enhance the program understanding in semantic levels by defining knowledge which is relevant to the domain of interest.The redocumentation process is done semi automatically which was initiated by the Software Work Products (SWP) and maps out to the metadata and generates it as ontology. Finally, the generated ontology will be mapped to standard software documentation such as the MIL-STD-498 based on the request of the maintainer by using the reasoning tools.

show abstract

“…Today, a growing body of literature on automated program documentation exists [17,22,30,31,32,33]. In [30], van Deursen and Moonen describe a tool, called TYPEEXPLORER, for browsing and understanding COBOL legacy systems at the level of individual statements as well as at the level of the software architecture.…”

Section: Tools and Techniquesmentioning

confidence: 99%

Empirical comparison of graphical and annotation-based re-documentation approaches

Torchiano

Ricca

Tonella³

2010

IET Softw.

View full text Add to dashboard Cite

Re-documentation is a complex activity that follows the comprehension of the code. Programmers record the knowledge they have gained in the form of text, views and diagrams that address specific aspects of the system under maintenance. Re-documentation of existing software can be achieved in several ways. The authors focus on two commonly used approaches: either using a drawing editor or annotating the source code. In the first case, diagrams are produced interactively, starting from the reverse engineered information. In the second case, design information is added in the form of code annotations. Diagrams may be produced, if needed, by an annotation-processing tool, which interprets the annotations previously inserted into the code and generates graphical views. The aim of this empirical work is the comparison of these two approaches, in order to understand which is easier to use and which the current limitations of both of them are. Preliminary results with master students indicate the drawing editor approach as the most preferred and usable, with no penalty on the quality of the resulting diagrams and on the effort required

show abstract

Incremental Redocumentation Using the Web

Cited by 14 publications

References 16 publications

A study of the documentation essential to software maintenance

A study of the documentation essential to software maintenance

A Software Redocumentation Process Using Ontology Based Approach in Software Maintenance

Empirical comparison of graphical and annotation-based re-documentation approaches

Contact Info

Product

Resources

About