Evaluation of Approaches for Documentation in Continuous Software Development
Evaluation of Approaches for Documentation in Continuous Software Development
Samenvatting
With the adoption of values, principles, practices, tools and processes from Agile, Lean, and DevOps, knowledge preservation by leaving out documentation has become a serious issue. We identify two questions that
are relevant for knowledge acquisition and distribution considering design decisions, rationale, or reasons for
code change. The first considers which knowledge you require upfront to start a project. The second question concerns continuation and addresses which knowledge is required afterward by others to deploy, use or
maintain a software product. We evaluate two approaches, which are ‘Just enough Upfront’ and ‘Executable
Documentatopn’ with in total of 25 artifacts. For the evaluation, we conducted a case study, supported by
a literature review, organizational and project metrics, and a survey. We looked into closed source-code and
closed classified source-code. We found that git commit messages typically contain what has been changed
but not why source-code has been changed. Design decisions, rationale, or reasons for code change should be
saved as close as possible to the source-code with Git Pull Requests. Second, and finally, knowledge about a
software product is not only written down in artifacts but is also a social construction between team members.
| Organisatie | |
| Afdeling | |
| Lectoraat | |
| Gepubliceerd in | Proceedings of the 18th International Conference on Evaluation of Novel Approaches to Software Engineering – ENASE, 401-411. Vol. 2023 |
| Datum | 2023-11-15 |
| Type | |
| DOI | 10.33540/1956 |
| Taal | Onbekend |






























