Executable Documentation: From Documentation Languages to Purpose-Specific Languages

Tegeler, Tim; Boßelmann, Steve; Schürmann, Jonas; Smyth, Steven; Teumert, Sebastian; Steffen, Bernhard

doi:10.1007/978-3-031-19756-7_10

Cited by 5 publications

(3 citation statements)

References 26 publications

Supporting

Mentioning

Contrasting

Order By: Relevance

“…This covers e.g., support based on integrated rules such as 'to proceed fill in this building block' or 'having entered something in block X, please add/re-check block Y'. In previous research, we have already developed similar applications via domain-specific languages adopting the graphical notations of domain experts (e.g., turning established documentation languages for visualizing deployment workflows into fully-fledged programming languages [39]). Our experience shows that this eases interdisciplinary collaboration throughout the requirements engineering, development and implementation phases [40], while lowering the entry barrier for non-experts [41].…”

Section: Discussionmentioning

confidence: 99%

Value-driven industry transformation: Leveraging open-source to establish new standards

Steffen,

Duparc,

Tegeler

2024

ITM Web Conf.

Self Cite

View full text Add to dashboard Cite

Traditional industries face growing pressure to digitally transform. In particular, established organizations must adopt new mindsets and act to remain competitive. To counter the challenges posed by monopolies and new entrants in a diverse and fiercely competitive landscape like Logistics, the Open Logistics Foundation (OLF) plays a pivotal role. It aims at fostering the development of logistics-specific open-source-software (OSS) to establish new digital services setting industry standards and ensuring enhanced connectivity and compatibility. The OLF represents an expanding core-community of dedicated logistics organizations. This core-community collaboratively identifies, selects, and develops relevant OSS for upcoming value-serving digital services and solutions. What sets this approach apart is its departure from the traditional solution-oriented open-source model. Instead of concluding with an OSS community, it starts with a dedicated core-community aiming at setting new widely adopted standards. However, even with this standard-driven approach, designing the right solution can be as challenging as finding a unicorn. To enhance the likelihood of success, this paper designed and evaluated the Minimum Viable core-Community driven Open-Source method (MV-COS). The MV-COS offers a comprehensive and standardized support allowing to holistically craft the vision, stakeholder-specific value propositions, and the corresponding implementation strategy of OSS projects. It prioritizes the early design and assessment of its likelihood to attract and align a critical mass of users which is the fundamental requirement for establishing new de-facto standards. The MV-COS enables to fail fast and iterate early, avoiding the unnecessary expenditure of resources.

show abstract

Section: Discussionmentioning

confidence: 99%

Value-driven industry transformation: Leveraging open-source to establish new standards

Steffen,

Duparc,

Tegeler

2024

ITM Web Conf.

Self Cite

View full text Add to dashboard Cite

show abstract

“…Another interesting approach is executable documentation [27] where domain-specific notations are turned into fullyfledged modelling/programming languages, or more specifically, domain specific languages (DSLs). There is a relation between documentation with software models as argued by Stevens [28], where models can be used to document software while in some cases, the documentation can be used to generate models.…”

Section: Related Workmentioning

confidence: 99%

“…There is a relation between documentation with software models as argued by Stevens [28], where models can be used to document software while in some cases, the documentation can be used to generate models. However, these approaches are still in their initial stages and require further research to be used in practice [27].…”

Section: Related Workmentioning

confidence: 99%

Towards identifying and minimizing customer-facing documentation debt

Silva

Unterkalmsteiner

Wnuk

2023

2023 ACM/IEEE International Conference on Technical Debt (TechDebt)

View full text Add to dashboard Cite

Background: Software documentation often struggles to catch up with the pace of software evolution. The lack of correct, complete, and up-to-date documentation results in an increasing number of documentation defects which could introduce delays in integrating software systems. In our previous study on a bug analysis tool called MultiDimEr, we provided evidence that documentation-related defects contribute to a significant number of bug reports. Aims: First, we want to identify documentation defect types contributing to documentation defects and thereby identifying documentation debt. Secondly, we aim to find pragmatic solutions to minimize most common documentation defects to pay off the documentation debt in the long run. Method: We investigated documentation defects related to an industrial software system. First, we looked at the types of different documentation and associated bug reports. We categorized the defects according to an existing documentation defect taxonomy. Results: Based on a sample of 101 defects, we found that a majority of defects are caused by documentation defects falling into the Information Content (What) category (86). Within this category, the documentation defect types Erroneous code examples (23), Missing documentation (35), and Outdated content (19) contributed to most of the documentation defects. We propose to adapt two solutions to mitigate these types of documentation defects. Conclusions: In practice, documentation debt can easily go undetected since a large share of resources and focus is dedicated to deliver high-quality software. This study provides evidence that documentation debt can contribute to increase in maintenance costs due to the number of documentation defects. We suggest to adapt two main solutions to tackle documentation debt by implementing (i) Dynamic Documentation Generation (DDG) and/or (ii) Automated Documentation Testing (ADT), which are both based on defining a single and robust information source for documentation.

show abstract

Discussing the Future Role of Documentation in the Context of Modern Software Engineering (ISoLA 2022 Track Introduction)

Havelund

Tegeler

Smyth

et al. 2022

Leveraging Applications of Formal Methods, Verification and Validation. Software Engineering

View full text Add to dashboard Cite

Executable Documentation: From Documentation Languages to Purpose-Specific Languages

Cited by 5 publications

References 26 publications

Value-driven industry transformation: Leveraging open-source to establish new standards

Value-driven industry transformation: Leveraging open-source to establish new standards

Towards identifying and minimizing customer-facing documentation debt

Discussing the Future Role of Documentation in the Context of Modern Software Engineering (ISoLA 2022 Track Introduction)

Contact Info

Product

Resources

About