| アイテムタイプ |
会議発表論文 / Conference Paper(1) |
| 公開日 |
2025-06-25 |
| タイトル |
|
|
タイトル |
Linking Code and Documentation Churn: Preliminary Analysis |
| 言語 |
|
|
言語 |
eng |
| キーワード |
|
|
主題Scheme |
Other |
|
主題 |
code churn |
| キーワード |
|
|
主題Scheme |
Other |
|
主題 |
software maintenance |
| キーワード |
|
|
主題Scheme |
Other |
|
主題 |
knowledge transfer |
| キーワード |
|
|
主題Scheme |
Other |
|
主題 |
automated documentation generation |
| 資源タイプ |
|
|
資源タイプ |
conference paper |
| アクセス権 |
|
|
アクセス権 |
embargoed access |
| 著者 |
Hovhannisyan, Ani
Fan, Youmei
Kula, Raula Gaikovina
Rodriguez-Perez, Gema
|
| 抄録 |
|
|
内容記述タイプ |
Abstract |
|
内容記述 |
Code churn refers to the measure of the amount of code added, modified, or deleted in a project and is often used to assess codebase stability and maintainability. Program comprehension or how understandable the changes are, is equally important for maintainability. Documentation is crucial for knowledge transfer, especially when new maintainers take over abandoned code. We emphasize the need for corresponding documentation updates, as this reflects project health and trustworthiness as a third-party library. Therefore, we argue that every code change should prompt a documentation update (defined as documentation churn). Linking code churn changes with documentation updates is important for project sustainability, as it facilitates knowledge transfer and reduces the effort required for program comprehension. This study investigates the synchrony between code churn and documentation updates in three GitHub open-source projects. We will use qualitative analysis and repository mining to examine the alignment and correlation of code churn and documentation updates over time. We want to identify which code changes are likely synchronized with documentation and to what extent documentation can be auto-generated. Preliminary results indicate varying degrees of synchrony across projects, highlighting the importance of integrated concurrent documentation practices and providing insights into how recent technologies like AI, in the form of Large Language Models (i.e., LLMs), could be leveraged to keep code and documentation churn in sync. The novelty of this study lies in demonstrating how synchronizing code changes with documentation updates can improve the development lifecycle by enhancing diversity and efficiency. |
| 書誌情報 |
en : Proceedings - 2024 IEEE 35th International Symposium on Software Reliability Engineering Workshops, ISSREW 2024
p. 107-108,
発行日 2024-12-03
|
| 会議情報 |
|
|
|
会議名 |
2024 IEEE 35th International Symposium on Software Reliability Engineering Workshops (ISSREW) |
|
|
開始年 |
2024 |
|
|
開始月 |
10 |
|
|
開始日 |
28 |
|
|
終了年 |
2024 |
|
|
終了月 |
10 |
|
|
終了日 |
31 |
|
|
開催期間 |
2024-10-28 - 2024-10-31 |
|
|
開催地 |
Tsukuba, Japan |
|
開催国 |
JPN |
| 出版者 |
|
|
出版者 |
IEEE |
| ISSN |
|
|
収録物識別子タイプ |
EISSN |
|
収録物識別子 |
2994-810X |
| 出版者版DOI |
|
|
関連タイプ |
isVersionOf |
|
|
識別子タイプ |
DOI |
|
|
関連識別子 |
https://doi.org/10.1109/ISSREW63542.2024.00058 |
| 出版者版URI |
|
|
関連タイプ |
isVersionOf |
|
|
識別子タイプ |
URI |
|
|
関連識別子 |
https://ieeexplore.ieee.org/abstract/document/10771325 |
| 権利 |
|
|
権利情報 |
$00A92024 IEEE. Personal use of this material is permitted. Permission from IEEE must be obtained for all other uses, in any current or future media, including reprinting/republishing this material for advertising or promotional purposes, creating new collective works, for resale or redistribution to servers or lists, or reuse of any copyrighted component of this work in other works. 出版社許諾条件により、本文は2026年12月03日以降に公開。 |
| 著者版フラグ |
|
|
出版タイプ |
AM |
| 助成情報 |
|
|
|
助成機関名 |
Japan Science and Technology Agency(JST) |
|
|
研究課題番号 |
JPMJBS2423 |
|
|
研究課題名 |
JST BOOST |
| 助成情報 |
|
|
|
助成機関名 |
Japan Society for the Promotion of Science (JSPS) |
|
|
研究課題番号 |
JP20H05706 |
|
|
研究課題名 |
次世代ソフトウェアエコシステムのための基盤・展開技術 |
| 助成情報 |
|
|
|
助成機関名 |
Japan Society for the Promotion of Science (JSPS) |
|
|
研究課題番号 |
JP23K28065 |
|
|
研究課題名 |
SPDXを活用したソフトウェアエコシステム分析基盤の開発 |
fulltext (97.1 KB)
