支援版本控制系統之文件撰寫工具;GeekNote A document attachment tool based on source code with version control

NCUIR > College of Electrical Engineering & Computer Science > Software Engineer > Electronic Thesis & Dissertation > Item 987654321/77378

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

Title:	支援版本控制系統之文件撰寫工具;GeekNote A document attachment tool based on source code with version control
Authors:	黃耀徵;Huang, Yao-Zheng
Contributors:	軟體工程研究所
Keywords:	文件撰寫;版本控制
Date:	2018-08-15
Issue Date:	2018-08-31 14:35:58 (UTC+8)
Publisher:	國立中央大學
Abstract:	在軟體工程中，程式碼交接一直是一個很重要的議題。隨著時代的發展，人們所撰寫的程式也越加龐大且複雜。文件是在軟體工程中，不可或缺的一環。現今的軟體開發人員，大多會使用版本控制系統，來處理不斷修改的程式碼。也因為程式碼的變動性很高，文件很容易與程式碼脫勾，進而導致文件失效。脫節的文件不僅讓文件的可用性降低，甚至可能會對閱讀文件的開發者產生誤導，造成反效果。另一個情況是假設文件已經與程式碼脫節，文件撰寫者想維護並更新文件時所面臨的問題。首先，文件撰寫者要先找出哪些地方的文件已過時，那些地方的文件還是可用的。分辨過時與非過時的文件並沒有無有效方法可以檢查，讓文件的維護造成了一個很大的問題。若是有一個能支援版本控制系統的文件撰寫工具，上述之問題都能迎刃而解。由於沒有能整合版本系統的文件撰寫工具，來解決文件與程式碼對不上的問題。本論文基於polytraceAid 的核心思想，並重新設計架構，且與版本控制系統Git 做結合。實作不相依程式語言且跨平台的文件撰寫工具GeekNote，使文件能與版本控制系統結合，藉此應映不斷修改的程式碼。GeekNote 不僅能夠幫助使用者在查找文件時，能夠快速找到對應版本程式碼。且能夠在程式碼修改時，得知文件失效。;n software engineering, code handover is a very important issue. As time goes, programs that people write are also larger and more complex. Documentation is an important part of software engineering. Most software developers today use version control systems to handle constantly changing code. Because of the high variability of the code, the document can be easily decoupled from the code and cause the document to become invalid. When someone wants to maintain and update the documentation. It is difficult to tell which documents are out of date or not. There is no effective way to distinguish between obsolete and non-stale document. That is a big problem for document maintenance. If there is a document writing tool that can support the version control system, the above problems can be solved. This paper develops an assist documentation tool GeekNote, which is non-dependent program language and cross-platform, based on the core idea of polytraceAid, and redesign the architecture and integrate it with the version control system(Git). GeekNote can not only help users find the corresponding version code quickly when searching for document, but also let users knows that the document is invalid when the code is modified.
Appears in Collections:	[Software Engineer] Electronic Thesis & Dissertation

Files in This Item:

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

社群 sharing

Loading...