dc.description.abstract | During the development and maintenance, if one code block is modified, another part of code must be modified together, then the coupling between the two code blocks is called maintenance coupling.
There are lots of maintenance couplings in most existing projects, but these couplings are not mentioned in the technical documents, which will also let other developers ignore the existence of coupling. During the development or maintenance, if developers fail to find the hidden maintenance couplings, and does not modify the code blocks with couplings together, it is likely to cause other bugs.
GeekyNote is a novel tool developed in our laboratory to address the major challenges in technical documentation, and we have also created the concept of coupling technical documents. Users can use coupling labels to link code blocks that have a coupling relationship with each other, and then cooperate with audio or video explanations to replace traditional technical documents written in texts and pass on known important information.
In order to improve the correctness and integrity of the coupling documents, as well as the convenience of making documents. This paper uses the Git commit history to analyze the maintenance coupling relationship existing in the project. Based on this analysis, users can automatically mark coupled code blocks. In addition, GeekyNote can also provide developers with detailed coupling information, so that developers no longer worry about software failures when modifying code, and reduce the risk of development. | en_US |