On the Creation and Maintenance of a Documentation Generator in an Applied Research Context.

Bernhard Dorninger, Josef Pichler, Michael Rappl, Jakob Sautter

Research output: Contribution to conferencePaperpeer-review

Abstract

Reverse engineering-based documentation generation extracts facts from software artefacts to generate suitable representations in another level of abstraction. Although the tool perspective in documentation generation has been studied before by many others, these studies mostly report on constructive aspects from case studies, e.g. how tools are built and evaluated. However, we believe a long-term perspective is important to cover issues that arise after initial deployment of a tool. In this paper, we present challenges and observations made during prototyping, development and maintenance of a documentation generator in an applied research project. Insights are drawn from different project phases over a period of 4-years and cover topics related to tool implementation as well as topics related to knowledge transfer in an applied research project. A key observation is that the maintenance of the system to be documented often triggers maintenance effort on the documentation generator.

Original languageEnglish
Pages129-140
Number of pages12
DOIs
Publication statusPublished - 24 Aug 2022

Keywords

  • Documentation generation
  • Prototyping
  • Research project
  • Reverse engineering
  • Software maintenance

Fingerprint

Dive into the research topics of 'On the Creation and Maintenance of a Documentation Generator in an Applied Research Context.'. Together they form a unique fingerprint.

Cite this