Incremental redocumentation with hypertext

Rajlich, Václav

doi:10.1109/csmr.1997.583009

Cited by 7 publications

(7 citation statements)

References 13 publications

Supporting

Mentioning

Contrasting

Order By: Relevance

“…Several papers report on the use of hypertext for the purpose of documenting software [4,18,7]. Of these, [7] follows the literate programming [14] approach as also used in, for example, Javadoc, enabling the programmer to control the generation of HTML by manually adding dedicated comment tags.…”

Section: Discussionmentioning

confidence: 99%

See 1 more Smart Citation

Building documentation generators

Deursen

Kuipers

1999

Proceedings IEEE International Conference on Software Maintenance - 1999 (ICSM'99). 'Software Maintenance for Business Change'

View full text Add to dashboard Cite

In order to maintain the consistency between sources and documentation, while at the same time providing documentation at the design level, it is necessary to generate documentation from sources in such a way that it can be integrated with hand-written documentation. In order to simplify the construction of documentation generators, we introduce island grammars, which only define those syntactic structures needed for (re)documentation purposes. We explain how they can be used to obtain various forms of documentation, such as data dependency diagrams for mainframe batch jobs. Moreover, we discuss how the derived information can be made available via a hypertext structure. We conclude with an industrial case study in which a 600,000 LOC COBOL legacy system is redocumented using the techniques presented in the paper.

show abstract

Section: Discussionmentioning

confidence: 99%

“…Hypertext has been proposed as a natural way of presenting software documentation [4,18] as the hyperlinks can be used to represent, for example, part of and uses relationships between between the documented components.…”

Section: Presenting Documentationmentioning

confidence: 99%

Building documentation generators

Deursen

Kuipers

1999

Proceedings IEEE International Conference on Software Maintenance - 1999 (ICSM'99). 'Software Maintenance for Business Change'

View full text Add to dashboard Cite

show abstract

“…This enables a uniform representation -dependence graphs -to be the basis of different levels of abstraction views that always remain closely related to the program itself; this ensures consistency between documentation and source code. Furthermore, the use of typed annotations allows for a wide variety of comments that can be tailored to specific tasks or to different users' levels of expertise [7], as well as for incremental redocumentation of programs [11], since annotations can be edited or extended at any moment.…”

Section: A Typical Applicationmentioning

confidence: 99%

Using dependence graphs as a support to document programs

Balmas

Proceedings. Second IEEE International Workshop on Source Code Analysis and Manipulation

View full text Add to dashboard Cite

In this paper, we argue that source code is not the best support for commenting programs and we introduce dependence graphs as a better support since they offer different levels of abstraction and make visible objects that are not directly represented in the source code.We first introduce our tool to display dependence graphs, focusing on how different views of the same program can be built and tuned by grouping together nodes that are syntactically or conceptually related. We also show how these views make visible objects of the program that aren't accessible for comment in the source code while they can be, in our tool, richly documented through typed annotations. Then we review which kinds of units can be commented this way and discuss a typical way to apply our tool to document programs. Finally, we give strategies towards the automation of program documentation.

show abstract

“…Hypertext for software documentation is discussed in several papers [4,22,5,23]. Our SDL documentation generator was inspired by DOCGEN [8], a generator for interactive, hyperlinked documentation about legacy systems.…”

Section: Related Workmentioning

confidence: 99%

Cost-effective maintenance tools for proprietary languages

Jonge

Monajemi

Proceedings IEEE International Conference on Software Maintenance. ICSM 2001

View full text Add to dashboard Cite

Incremental redocumentation with hypertext

Cited by 7 publications

References 13 publications

Building documentation generators

Building documentation generators

Using dependence graphs as a support to document programs

Cost-effective maintenance tools for proprietary languages

Contact Info

Product

Resources

About