Enhancing Code Documentation Efficiency: A Documentation-on-the-Fly Approach on GeekyNotes Web

NCUIR > College of Electrical Engineering & Computer Science > Graduate Institute of Computer Science and Information Engineering > Electronic Thesis & Dissertation > Item 987654321/95602

Please use this identifier to cite or link to this item: http://ir.lib.ncu.edu.tw/handle/987654321/95602

Title:	Enhancing Code Documentation Efficiency: A Documentation-on-the-Fly Approach on GeekyNotes Web
Authors:	雷曼亞;Ramadhan, Aditya Orba
Contributors:	資訊工程學系
Keywords:	知識傳輸;文件;文件工具;On-the-fly文件;Knowledge Transfer;Documentation;Documentation Tool;On-the-fly documentation
Date:	2024-07-26
Issue Date:	2024-10-09 17:05:37 (UTC+8)
Publisher:	國立中央大學
Abstract:	根據先前的研究，有幾個關鍵因素顯著影響軟體開發人員的滿意度。這些因素包括擁有能夠有效協作的熟練同事、與團隊成員的近距離接觸以實現無縫溝通和支援，以及可用的全面文檔，有助於理解和導航複雜的專案。高質量的文檔可以提高每個專案中工程師的表現。研究發現，即使是過時的文檔也可能有用。文檔的價值是根據其向使用者傳授知識的能力來判斷的，即使它並非最新。因此，由於工作量繁重和軟體開發人員在知識轉移過程中偏好非正式的溝通方式，維護最新且全面的文檔仍然是一個挑戰。此外，文檔有時不會集中收集，這使得找到它變得更加困難。本論文通過在開發過程中引入一種標準化的合併請求(MR)結構，包括解釋、評估和視頻部分，提出了一種即時文檔(Documentation-On-The-Fly)方法來應對這些挑戰。這種方法旨在通過納入詳細的解釋、實施方法和單元測試信息(以視頻格式呈現)，簡化文檔過程，與傳統的書面方法相比，大大減少了所需的時間。我們已經擁有一個集中的文檔平台 GeekyNotes。為了整合文檔標準，我們創建了一個名為視頻標籤的新標籤系統。這個標籤自動將相關視頻附加到每個 MR 中的代碼更改上，通過提供實時更新來提高文檔效率。通過利用這種結構化的文檔方法和視頻標籤系統，我們旨在改進 GeekyNotes 的網頁功能，如覆蓋率和耦合系統，從而促進軟體開發和維護過程。採用這種方法，文檔可以與開發過程同步完成，確保每個軟體功能都有更高程度的完整性。我們的視頻標籤文檔方法增強了知識轉移，並提高了軟體開發項目的效率。通過解決現有的文檔挑戰，它顯著提升了軟體開發人員的生產力。;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.
Appears in Collections:	[Graduate Institute of Computer Science and Information Engineering] Electronic Thesis & Dissertation

Files in This Item:

File	Description	Size	Format
index.html		0Kb	HTML	17	View/Open

社群 sharing

Loading...