| 姓名 |
雷曼亞(Aditya Orba Ramadhan)
查詢紙本館藏 |
畢業系所 |
資訊工程學系 |
| 論文名稱 |
(Enhancing Code Documentation Efficiency: A Documentation-on-the-Fly Approach on GeekyNotes Web)
|
| 相關論文 | |
| 檔案 |
 [Endnote RIS 格式]
[Bibtex 格式]
 [相關文章]  [文章引用]  [完整記錄]  [館藏目錄]  [檢視] [下載]- 本電子論文使用權限為同意立即開放。
- 已達開放權限電子全文僅授權使用者為學術研究之目的，進行個人非營利性質之檢索、閱讀、列印。
- 請遵守中華民國著作權法之相關規定，切勿任意重製、散佈、改作、轉貼、播送，以免觸法。
|
| 摘要(中) |
根據先前的研究，有幾個關鍵因素顯著影響軟體開發人員的滿意度。這些因素包括擁 有能夠有效協作的熟練同事、與團隊成員的近距離接觸以實現無縫溝通和支援，以及可 用的全面文檔，有助於理解和導航複雜的專案。高質量的文檔可以提高每個專案中工程 師的表現。研究發現，即使是過時的文檔也可能有用。文檔的價值是根據其向使用者傳 授知識的能力來判斷的，即使它並非最新。因此，由於工作量繁重和軟體開發人員在知 識轉移過程中偏好非正式的溝通方式，維護最新且全面的文檔仍然是一個挑戰。此外， 文檔有時不會集中收集，這使得找到它變得更加困難。
本論文通過在開發過程中引入一種標準化的合併請求(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. |
| 關鍵字(中) |
★ 知識傳輸
★ 文件
★ 文件工具
★ On-the-fly文件 |
關鍵字(英) |
★ Knowledge Transfer
★ Documentation
★ Documentation Tool
★ On-the-fly documentation |
| 論文目次 |
Table of Contents
List of Figures ..........................................................................................................................vii
List of Tables...........................................................................................................................viii
CHAPTER 1 INTRODUCTION..................................................................................................... 1
CHAPTER 2 LITERATURE REVIEW ............................................................................................. 4
2.1 Related Works ........................................................................................................................4
2.1.1 Software Developer Challenges & Satisfication ....................................................................................4
2.1.2 Software Documentation Issues............................................................................................................5
2.1.3 Knowledge Transfer ..............................................................................................................................10
2.1.4 GeekyNotes..........................................................................................................................................11
CHAPTER 3 PROBLEM DESCRIPTION & ANALYSIS .................................................................... 13
3.1 Introduction.......................................................................................................................... 13
3.2 Ineffective Knowledge Transfer............................................................................................. 14
3.2.1 Description ..........................................................................................................................................14
3.2.2 Impact..................................................................................................................................................14
3.3 Un Automatically Attach Documentation .............................................................................. 14
3.3.1 Description ..........................................................................................................................................14
3.3.2 Impact..................................................................................................................................................15
3.4 How to Address..................................................................................................................... 15
3.4.1 Implementation Challenges and Solutions..........................................................................................15
3.4.2 Merge Request Standard.....................................................................................................................16
3.4.3 Video Label..........................................................................................................................................17
3.5 Expected Results................................................................................................................... 18
CHAPTER 4 MERGE REQUEST IMPLEMENTATION................................................................... 19
4.1 Development Workflow........................................................................................................ 19
4.2 Merge Request Standard....................................................................................................... 20
CHAPTER 5 VIDEO LABEL IMPLEMENTATION........................................................................... 24
5.1 GitLab Merge Request APIs................................................................................................... 24
5.1.1 Merge Request List..............................................................................................................................24
5.1.2 Merge Request Commits.....................................................................................................................25
5.1.3 Merge Request Diff Changes...............................................................................................................26
5.2 Video Label ........................................................................................................................... 27
5.2.1 Back-End Implementation...................................................................................................................28
5.2.2 Front-End Implementation..................................................................................................................29
CHAPTER 6 RESULT & EVALUATION ....................................................................................... 30
6.1 Result.................................................................................................................................... 30
6.2 Evaluation............................................................................................................................. 34
CHAPTER 7 CONCLUSION........................................................................................................ 36
CHAPTER 8 BIBLIOGRAPHY.................................................................................................... 38 |
| 參考文獻 |
1. Forward, A. and T.C. Lethbridge. The relevance of software documentation, tools and technologies: a survey. in Proceedings of the 2002 ACM symposium on Document engineering. 2002.
2. Kajko-Mattsson, M., A survey of documentation practice within corrective maintenance. Empirical Software Engineering, 2005. 10: p. 31-55.
3. Fernández-Sáez, A.M., et al. On the use of UML documentation in software maintenance: Results from a survey in industry. in 2015 ACM/IEEE 18th International Conference on Model Driven Engineering Languages and Systems (MODELS). 2015. IEEE.
4. Storey, M.-A., et al., Towards a theory of software developer job satisfaction and perceived productivity. IEEE Transactions on Software Engineering, 2019. 47(10): p. 2125-2142.
5. Aghajani, E., et al. Software documentation issues unveiled. in 2019 IEEE/ACM 41st International Conference on Software Engineering (ICSE). 2019. IEEE.
6. Cheng, Y.-P., et al. GeekyNote: a technical documentation tool with coverage, backtracking, traces, and couplings. in Proceedings of the ACM/IEEE 42nd International Conference on Software Engineering: Companion Proceedings. 2020.
7. Buchgeher, G., et al. Providing technical software documentation as a service-an industrial experience report. in 2018 25th Asia-Pacific Software Engineering Conference (APSEC). 2018. IEEE.
8. Viana, D., T. Conte, and C.R. de Souza. Knowledge Transfer between Senior and Novice Software Engineers: A Qualitative Analysis. in SEKE. 2014.
9. Lethbridge, T.C., J. Singer, and A. Forward, How software engineers use documentation: The state of the practice. IEEE software, 2003. 20(6): p. 35-39.
10. Studios, N. Ranked: Worst Companies for Employee Retention (U.S. and UK). [cited 2024 7 July]; Available from: https://www.visualcapitalist.com/cp/ranked-worst-companies-for-employee- retention-u-s-and-uk/.
11. Batra, A. Various reason why software developer choose to leave the industry. 2023 [cited 2024 7 July]; Available from: https://www.quora.com/Why-do-developers-resign.
12. GitLab. Merge Request List API. [cited 2024 10 May]; Available from: https://docs.gitlab.com/ee/api/merge_requests.html#list-project-merge-requests.
13. GitLab. Merge Request Commit List API. [cited 2024 10 May]; Available from: https://docs.gitlab.com/ee/api/merge_requests.html#get-single-merge-request-commits.
14. GitLab. Merge Request Changes API. [cited 2024 10 May]; Available from: https://docs.gitlab.com/ee/api/merge_requests.html#get-single-merge-request-changes. |
| 指導教授 |
鄭永斌(Yung-Pin Cheng)
|
審核日期 |
2024-7-26 |
| 推文 |
 facebook  plurk  twitter  funp  google  live  udn  HD  myshare  reddit  netvibes  friend  youpush  delicious  baidu
|
| 網路書籤 |
 Google bookmarks  del.icio.us  hemidemi myshare
|
