Evaluation of approaches for documentation in continuous software development

  • Theo Theunissen*
  • , Stijn Hoppenbrouwers
  • , Sietse Overbeek
  • *Corresponding author for this work

    Research output: Chapter in Book/Report/Conference proceedingConference contributionAcademicpeer-review

    Abstract

    With the adoption of values, principles, practices, tools and processes from Agile, Lean, and DevOps, knowledge preservation has become a serious issue because documentation is largely left out. We identify two questions that are relevant for knowledge acquisition and distribution concerning design decisions, rationales, or reasons for code change. The first concerns which knowledge is required upfront to start a project. The second question concerns continuation after initial development and addresses which knowledge is required by those who deploy, use or maintain a software product. We evaluate two relevant approaches for alleviating the issues, which are 'Just enough Upfront' and 'Executable Documentation' with a total of 25 related 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 two conclusive remarks. First, 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, knowledge about a software product is not only written down in artifacts but is also a social construction between team members.

    Original languageEnglish
    Title of host publicationProceedings of the 18th International Conference on Evaluation of Novel Approaches to Software Engineering, ENASE 2023, Prague, Czech Republic
    Subtitle of host publicationProceedings of the 18th International Conference on Evaluation of Novel Approaches to Software Engineering
    EditorsHermann Kaindl, Mike Mannion, Leszek Maciaszek
    PublisherSciTePress
    Pages404-411
    Number of pages8
    ISBN (Electronic)9789897586477
    DOIs
    Publication statusPublished - 2023

    Publication series

    NameInternational Conference on Evaluation of Novel Approaches to Software Engineering, ENASE - Proceedings
    Volume2023-April
    ISSN (Electronic)2184-4895

    Bibliographical note

    Publisher Copyright:
    Copyright © 2023 by SCITEPRESS - Science and Technology Publications, Lda. Under CC license (CC BY-NC-ND 4.0)

    Keywords

    • Artifacts
    • Continuous Software Development
    • Documentation
    • Executable Documentation
    • Just Enough Upfront

    Fingerprint

    Dive into the research topics of 'Evaluation of approaches for documentation in continuous software development'. Together they form a unique fingerprint.

    Cite this