Building Documentation Generators

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 dene 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. 1991 ACM Computing Classication System: D.2.2, D.2.5, D.2.7, D.3.4 Keywords and Phrases: Redocumentation, legacy systems, documentation generation, source code analysis, isl...

• Type: Conference
• Year: 1999
• Where: ICSM
• Authors: Arie van Deursen, Tobias Kuipers
• Keywords: Documentation, ICSM 1999, Island Grammars, Software Engineering, Time Providing Documentation