TY - CONF
T1 - On the Creation and Maintenance of a Documentation Generator in an Applied Research Context.
AU - Dorninger, Bernhard
AU - Pichler, Josef
AU - Rappl, Michael
AU - Sautter, Jakob
N1 - Funding Information:
The development of the presented documentation generator was conducted within an applied research project funded by the COMET funding program. The research project Reverse Engineering Based Software Evolution and Documentation (REEDS ) exploits reverse engineering-based approaches for the automated generation of software documentation. REEDS builds upon methods for static and dynamic source code analysis with the goals to recover knowledge from software systems (1), represent that knowledge by domain-and stakeholder-specific documentation models and visualizations (2), efficiently generate documentation (3) that may be generated on-demand (4), conforms to standards and legal regulations (5) or facilitates the analysis of system evolution (6).
Publisher Copyright:
© 2022, The Author(s), under exclusive license to Springer Nature Switzerland AG.
PY - 2022/8/24
Y1 - 2022/8/24
N2 - 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.
AB - 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.
KW - Documentation generation
KW - Prototyping
KW - Research project
KW - Reverse engineering
KW - Software maintenance
UR - http://www.scopus.com/inward/record.url?scp=85136962656&partnerID=8YFLogxK
U2 - 10.1007/978-3-031-14343-4_13
DO - 10.1007/978-3-031-14343-4_13
M3 - Paper
SP - 129
EP - 140
ER -