| dc.description.abstract | Based on previous studies, several key factors significantly impact software developer satisfaction. Among these factors are the presence of skilled co-workers who can collaborate effectively, the proximity to their team members for seamless communication and support, and the availability of comprehensive documentation that aids in understanding and navigating complex projects. Good quality documentation can improve the performance engineers working on each project. It has been found that even outdated documents can be useful. The value of documentation is judged based on its ability to impart knowledge to its users, even when it is not up to date. Therefore, maintaining up-to-date and comprehensive documentation remains a challenge due to heavy workloads and software developers′ preference for informal communication methods during the knowledge transfer process. Additionally, documentation is sometimes not collected centrally, making it even more difficult to find.
This thesis addresses these challenges by introducing a Documentation-On-The-Fly approach through a standardized structure of Merge Requests (MRs) during development, which includes Explanation, Evaluation, and Video sections. This approach aims to streamline the documentation process by incorporating detailed explanations, implementation methods, and unit testing information in video format, significantly reducing the time required compared to traditional written methods. We already have a centralized documentation platform, GeekyNotes. To integrate the documentation standard, we created a new labeling system called video-label. This label automatically attaches relevant videos to code changes in each MR, enhancing documentation efficiency by providing real-time updates. By leveraging this structured documentation approach and the video-label system, we aim to improve the functionality of GeekyNotes′ web features, such as coverage and coupling systems, thereby facilitating software development and maintenance processes.
With this approach, documentation can be completed concurrently with the development process, ensuring a higher level of completeness for each software feature. Our video-label documentation approach enhances knowledge transfer and improves efficiency within
software development projects. By addressing existing documentation challenges, it significantly boosts software developer productivity. | en_US |