軟件文檔
| 軟件開發 |
|---|
| 核心行動 |
| 範式與模式 |
| 方法論與框架 |
| 支持行為 |
| 實踐 |
| 工具 |
| 標準與知識體系 |
軟件文檔或者源代碼文檔是指與軟件系統及其軟件工程過程有關聯的文本實體。文檔的類型包括軟件需求文檔，設計文檔，測試文檔，用戶手冊等。其中的需求文檔，設計文檔和測試文檔一般是在軟件開發過程中由開發者寫就的，而用戶手冊等非過程類文檔是由專門的非技術類寫作人員寫就的。
早期的軟件文檔主要指的是用戶手冊，根據Barker[1]的定義，文檔是用來對軟件系統界面元素的設計、規劃和實現過程的記錄，以此來增強系統的可用性。而Forward[2] 則認為軟件文檔是被軟件工程師之間用作溝通交流的一種方式，溝通的信息主要是有關所開發的軟件系統。Parnas[3]則強調文檔的權威性，他認為文檔應該提供對軟件系統的精確描述。
綜上，我們可以將軟件文檔定義為：
- 文檔是一種對軟件系統的書面描述；
- 文檔應當精確地描述軟件系統；
- 軟件文檔是軟件工程師之間用作溝通交流的一種方式；
- 文檔的類型有很多種，包括軟件需求文檔，設計文檔，測試文檔，用戶手冊等；
- 文檔的呈現方式有很多種，可以是傳統的書面文字形式或圖表形式，也可是動態的網頁形式
參考文獻[編輯]
- ^ T. T. Barker, "Software documentation: from instruction to integration," IEEE Transactions on Professional Communication, vol. 33, no. 4, 1990.
- ^ A. Forward, "Software Documentation – Building and Maintaining Artefacts of Communication," in Ottawa-Carleton Institute for Computer Science. vol. Master in Computer Science: University of Ottawa, 2002.
- ^ D. L. Parnas, "Precise Documentation: The Key To Better Software," in The Future of Software Engineering: Springer-Verlag Berlin Heidelberg, 2011, pp. 125-148.