“軟件文檔編寫”教學

【摘 要】本文從實際出發，結合自身體會，針對在教學中遇到的普遍性問題，提出一些對于“軟件文檔編寫”課程的教學建議。

【關鍵詞】高職 “軟件文檔編寫” 教學

【中圖分類號】G642 【文獻標識碼】A 【文章編號】1674-4810（2013）17-0066-02

一份關于計算機人才需求的調研報告中提到：寫作能力也是用人單位很重視的一種重要技能。有不少畢業生在工作中的應用寫作能力有待于提高，往往是心里有話，卻無法清楚透徹地表達，缺乏清晰的思路、算法和邏輯過程。同樣，畢業生普遍認為計算機專業課程設置中文科課程的比例太少了，應加強應用性、科技性寫作的訓練。

一 教學中遇到的問題

從調研報告了解到，文檔寫作應成為高職高專計算機技術類相關專業教學的重點。有許多院校已經把“軟件文檔編寫”設為必修課程，但效果并不佳。本人通過幾年的教學工作，總結了以下幾點在這門課程教學中遇到的問題。

1.學生不重視文檔寫作

一提到文檔寫作，學生的第一印象是一篇篇比較枯燥的文章，容易產生厭學心理。對于多數高職計算機專業的學生而言，他們認為專業技能的高低是將來就業的關鍵，至于文檔寫好寫壞無關緊要。

2.學生文字表達能力不強

多數高職學生普遍存在語文水平不高、文字表達能力較弱的現象。有些學生甚至表示最討厭寫作文，所以也不喜歡寫文檔。

3.學生生搬硬套，無法靈活掌握

有些學生在寫文檔時會直接套用模板或抄襲，有些學生不顧內容，文檔填滿就算是完成任務了。這樣導致文檔不但缺乏邏輯性，而且也毫無真實性。

4.學生基礎課程的知識不扎實

文檔寫作和軟件工程的生命周期是息息相關的，開發的每個過程都會產生相應的文檔，這就要求學生能對軟件開發的整體過程有個初步的概念。學生在沒有掌握好相關學科知識的情況下，很難寫出較好的文檔。

二 改進措施

針對以上問題，總結自身的教學體會，本人認為可以通過以下幾點來改進這門課程的教學。

1.提高學生對文檔的認識

第一，從正面介紹文檔的重要性。在初次授課時，讓學生打開任意一個招聘網站，搜索有關軟件文檔的崗位信息，介紹相關的職位描述和任職要求。學生會很驚訝地發現，原來寫文檔也是一個發展和就業的方向。

第二，介紹一些大型公司軟件文檔的應用方式，如軟件文檔是大型國際化軟件的組成部分，包括用戶手冊、聯機幫助、市場宣傳資料等。大型軟件外包服務公司內部都開發了軟件內容管理系統（CMS），設有專門的寫作團隊，為軟件開發商提供多種形式的文檔內容寫作、排版、測試等服務。內容寫作可能是網頁形式，也可能是多媒體課件、需要印刷的產品文檔、包裝材料和市場宣傳材料等。通過提供專業的內容寫作服務，使得內容與應用程序有效集成，增強用戶的體驗，也降低了軟件開發商的成本。

第三，從反面談談文檔的重要性。如《IT經理世界》刊登了這樣一篇文章《下班后你的公司還值多少錢》。文章開頭講了這樣一個小故事：一位軟件公司的老總感慨地說：“做軟件公司，最痛苦的事情是下班之后，你發現自己的公司除了幾臺電腦外，幾乎什么也沒有了。因為公司最值錢的資產都在每個程序員的腦子里，這些人一旦離開，公司的資產就等于零。”通過此例引導學生懂得，文檔能體現設計思想和研究成果，將不可見的軟件開發進程轉換成可見的文字資料。

2.加強學生的表達能力

表達能力的培養不是一朝一夕的事情，優秀的文檔案例必不可少。但要強調的是文檔寫作不是寫作文，不要求有很好的文采，但是描述一定要清晰、明確，一定要符合項目實際情況，而且盡量采用專業術語以及圖形來輔助，如大量使用面向對象的UML（統一建模語言）。清晰的圖示能高效說明問題，圖文并茂的文檔才有更好的可讀性。

3.案例教學+團隊協作

這門課程的實踐性較強，必須結合實際的軟件開發案例，采用理論和實踐相結合的案例教學法來進行教學。在具體教學過程中，應輕形式、重實效，課堂上以一套完整的實際項目文檔來教學，另外布置一個項目的文檔作為作業或學期作品，確保學生親自動手完成的時間。學生可以組隊完成項目作品，對軟件進行準確需求分析和詳細設計，并正確采用相應文檔來表達。學期末通過項目評審的形式進行作品評比，制造再學習的機會，讓學生互相找缺點，取長補短。

4.培養學生良好的寫作習慣

第一，培養寫作的規范性。如在文檔中選取的表達方式要統一，字體、標注、說明、命名規則等都要形成統一的風格。文檔的模板根據項目的大小采用相關的國家或國際標準。

第二，培養寫作的實時性。在實際的項目中，需求的變更是常有的事，那么文檔也要根據變更的內容進行相應修改。建議可以模擬項目的變更，讓學生進行文檔版本的控制，

如設置1.0版本、2.0版本等。

5.加強學科間的交叉互動

這門課程涉及許多相關學科的知識，如軟件工程、軟件項目管理、需求分析與設計、UML統一建模語言等課程，所以在指導學生寫作時，需要注意學科間的交叉互動與知識的拓展。

三 總結

隨著計算機技術的不斷發展，教師只有與時俱進，不斷改善教學內容和教學方法，適應課程的需要，才能在教學中取得更好的教學效果。

參考文獻

[1]國際化軟件開發與外包測試集成[EB/OL].http：//tech.

it168.com/m/2008-04-26/200804261604358.shtml

[2]潘孝銘、幸明海.軟件文檔編寫[M].北京：高等教育出版社，2004

〔責任編輯：李冰〕