Providing technical software documentation as a service - An industrial experience report

Authors Georg Buchgeher
Bernhard Dorninger
Claus Klammer
Albin Kern
Editors
Title Providing technical software documentation as a service - An industrial experience report
Booktitle Proceedings of the 25th Asia-Pacific Software Engineering Conference (APSEC 2018)
Type in proceedings
Publisher IEEE
ISBN 978-1-7281-1970-0
DOI 10.1109/APSEC.2018.00073
Month December
Year 2018
Pages 581-590
SCCH ID# 18067
Abstract

Technical software documentation is an essential source of knowledge supporting many different software development activities and stakeholders. In this paper we report on use cases, existing documentation practices, and open challenges for technical software documentation in a company from the manufacturing domain. Further, we present an approach for automatically providing technical software documentation as a service. The approach has been validated in an industrial setting, i.e., we report on our experiences and lessons learned. Validation shows that while up-to-date and dynamically explorable documentation could be provided, the proposed solution failed in sufficiently supporting different stakeholders and their concerns i.e., it failed in providing sustainable documentation and knowledge preservation over time.