面向案例驅動的軟件文檔撰寫能力培養研究

劉海燕+王曉池+張立杰+陶永鵬

摘 要 為了改善軟件專業學生重編程輕文檔的現狀，采用面向案例驅動的軟件文檔撰寫教學方法。通過系統的軟件文檔寫作實踐，培養學生撰寫用戶文檔、開發文檔和管理文檔的技能，鍛煉學生編制、管理和維護軟件文檔的能力，同時也為提高學生的畢業論文撰寫水平奠定基礎。

關鍵詞 軟件文檔寫作；案例驅動；畢業論文

中圖分類號：G642.0 文獻標識碼：B

文章編號：1671-489X（2017）18-0092-03

Research on Case-Driven Software Document Writing Ability Training//LIU Haiyan， WANG Xiaochi， ZHANG Lijie， TAO Yong-peng

Abstract In order to improve the current situation of emphasizing programming and despising documents for software majors stu-dents， the case-driven teaching method is adopted in the practice of software document writing. Through the system practice of software document writing， improve students skills to write user documents， development documents and management documents. Train the abi-

lity of students to develop， manage and maintain software docu-ments. At the same time， lay the foundation for improving the gra-duation thesis writing level of students.

Key words software document writing； case-driven； graduation thesis

1 前言

計算機軟件由程序、數據和文檔組成，文檔是計算機軟件產品的重要組成部分。文檔記錄目標系統各個階段的設計思想和研究成果，不僅是項目管理的依據、技術交流的語言、軟件質量的保證、人員培訓的資料、軟件維護的支持、軟件歷史的記載和檔案，而且在開發人員、維護人員、管理人員、用戶與計算機之間起到橋梁作用[1]。如果無開發計劃、無文檔地直接面對計算機編程，軟件開發過程中的可見度很低，就會導致軟件開發周期加長，開發和維護成本提高，軟件質量得不到保障。因此，近年來越來越多的軟件企業意識到軟件文檔撰寫的重要性。

軟件專業的學生需要了解軟件文檔在軟件開發過程中的作用，了解各種文檔編制規范，熟悉軟件文檔的編寫方法，能夠根據項目要求，初步具備按照國家標準和國際規范撰寫軟件生命周期各階段文檔的能力。

2 軟件文檔寫作教學內容

軟件文檔寫作課程主要介紹軟件文檔的基本概念、標準、表達、要求和管理維護，以及開發文檔、管理文檔和用戶文檔的撰寫內容和方法，主要教學內容如表1所示。……