軟件工程文檔寫作

軟件工程文檔寫作十年前，你周圍的人會根據(jù)你父母的收入對待你。十年后，你周圍的人會根據(jù)你的收入對待你的父母和你的孩子！這就是人性和人生，除了努力別無選擇。記住：沒有傘的孩子，必須努力奔跑！帶上自己的陽光，照亮自己的心靈。心靈的力量是無窮的，它可以把一朵花變成一座花園，也可以把一滴水變成清泉。幸福其實就是一種心境，所謂“人生由我不由天，幸福由心不由境”，只要你心中有陽光，無論走到哪里，無論發(fā)生任何事情，你都會覺得是幸福的。不要老嘆息過去，它是不再回來的;要明智地改善現(xiàn)在。要以不憂不懼的堅決意志投入撲朔迷離的未來?！寿M(fèi)羅【美】任世事浮華，惟愿在日出日落的光陰里，靜靜收集庭院檐下的花香與鳥語，在細(xì)水長流的歲月里撒播微笑與善良，在薄如蟬翼的時光里執(zhí)筆畫心簡靜如水，珍藏生活中點(diǎn)點(diǎn)滴滴的感動和絲絲縷縷的幸福。拋棄時間的人，時間也拋棄他。_____莎士比亞軟件工程文檔寫作軟件工程文檔寫作十年前，你周圍的人會根據(jù)你父母的收入對待你。十年后，你周圍的人會根據(jù)你的收入對待你的父母和你的孩子！這就是人性和人生，除了努力別無選擇。記?。簺]有傘的孩子，必須努力奔跑！帶上自己的陽光，照亮自己的心靈。心靈的力量是無窮的，它可以把一朵花變成一座花園，也可以把一滴水變成清泉。幸福其實就是一種心境，所謂“人生由我不由天，幸福由心不由境”，只要你心中有陽光，無論走到哪里，無論發(fā)生任何事情，你都會覺得是幸福的。不要老嘆息過去，它是不再回來的;要明智地改善現(xiàn)在。要以不憂不懼的堅決意志投入撲朔迷離的未來?！寿M(fèi)羅【美】任世事浮華，惟愿在日出日落的光陰里，靜靜收集庭院檐下的花香與鳥語，在細(xì)水長流的歲月里撒播微笑與善良，在薄如蟬翼的時光里執(zhí)筆畫心簡靜如水，珍藏生活中點(diǎn)點(diǎn)滴滴的感動和絲絲縷縷的幸福。拋棄時間的人，時間也拋棄他。_____莎士比亞什么是文檔文檔(document)是指某種數(shù)據(jù)媒體和其中所記錄的數(shù)據(jù)。它具有永久性，并可以由人或機(jī)器閱讀，通常僅用于描述人工可讀的東西。在軟件工程中，文檔常常用來表示對活動、需求、過程或結(jié)果進(jìn)行描述、定義、規(guī)定、報告或認(rèn)證的任何書面或圖示的信息。軟件文檔的作用在軟件生產(chǎn)過程中，軟件文檔在產(chǎn)品的開發(fā)過程中起著重要的作用：提高軟件開發(fā)過程的能見度。把開發(fā)過程中發(fā)生的事件以某種可閱讀的形式記錄在文檔中。管理人員可把這些記載下來的材料作為檢查軟件開發(fā)進(jìn)度和開發(fā)質(zhì)量的依據(jù)，實現(xiàn)對軟件開發(fā)的工程管理。提高開發(fā)效率。軟件文檔的編制，使得開發(fā)人員對各個階段的工作都進(jìn)行周密思考、全盤權(quán)衡、減少返工。并且可在開發(fā)早期發(fā)現(xiàn)錯誤和不一致性，便于及時加以糾正。作為開發(fā)人員在一定階段的工作成果和結(jié)束標(biāo)志。記錄開發(fā)過程中有關(guān)信息，便于協(xié)調(diào)以后的軟件開發(fā)、使用和維護(hù)。軟件文檔的作用提供對軟件的運(yùn)行、維護(hù)和培訓(xùn)的有關(guān)信息，便于管理人員、開發(fā)人員、操作人員、用戶之間的協(xié)作、交流和了解。使軟件開發(fā)活動更科學(xué)、更有成效。便于潛在用戶了解軟件的功能、性能等各項指標(biāo)，為他們選購符合自己需要的軟件提供依據(jù)。軟件文檔的作用文檔的橋梁作用文檔的分類軟件文檔從形式上來看，大致可分為兩類：一類是開發(fā)過程中填寫的各種圖表，稱之為工作表格；一類是應(yīng)編制的技術(shù)資料或技術(shù)管理資料，稱之為文檔或文件。按照文檔產(chǎn)生和使用的范圍，軟件文檔大致可分為三類：1、開發(fā)文檔軟件需求說明書數(shù)據(jù)要求說明書概要設(shè)計說明書詳細(xì)設(shè)計說明書可行性研究報告項目開發(fā)計劃文檔的分類2、管理文檔項目開發(fā)計劃測試計劃測試報告開發(fā)進(jìn)度月報項目開發(fā)總結(jié)3、用戶文檔用戶手冊操作手冊維護(hù)修改建議軟件需求說明書文檔的分類軟件文檔的工作國家標(biāo)準(zhǔn)局在1988年1月發(fā)布了《計算機(jī)軟件開發(fā)規(guī)范》《軟件產(chǎn)品開發(fā)文件編制指南》作為軟件開發(fā)人員工作的準(zhǔn)則和規(guī)程。它們基于軟件生存期方法，把軟件產(chǎn)品從形成概念開始，經(jīng)過開發(fā)、使用和不斷增補(bǔ)修訂，直到最后被淘汰的整個過程應(yīng)提交的文檔歸于以下十三種。1、可行性研究報告說明該軟件項目的實現(xiàn)在技術(shù)上、經(jīng)濟(jì)上和社會因素上的可行性;評述為合理地達(dá)到開發(fā)目標(biāo)可供選擇的各種可能的實現(xiàn)方案;說明并論證所選定實施方案的理由。文檔的分類2、項目開發(fā)計劃 為軟件項目實施方案制定出的具體計劃。它包括各部分工作的負(fù)責(zé)人員開發(fā)的進(jìn)度開發(fā)經(jīng)費(fèi)的概算所需的硬件和軟件資源等 項目開發(fā)計劃應(yīng)提供給管理部門，并作為開發(fā)階段評審的基礎(chǔ)。文檔的分類3、軟件需求說明書 對目標(biāo)軟件的功能、性能、用戶界面及運(yùn)行環(huán)境等作出詳細(xì)的說明。 它是用戶與開發(fā)人員雙方對軟件需求取得共同理解基礎(chǔ)上達(dá)成的協(xié)議，也是實施開發(fā)工作的基礎(chǔ)。4、數(shù)據(jù)要求說明書 給出數(shù)據(jù)邏輯描述和數(shù)據(jù)采集的各項要求,為生成和維護(hù)系統(tǒng)的數(shù)據(jù)文件做好準(zhǔn)備。文檔的分類5、概要設(shè)計說明書 該說明書是概要設(shè)計工作階段的成果。它應(yīng)當(dāng)說明系統(tǒng)的功能分配模塊劃分程序的總體結(jié)構(gòu)輸入輸出及接口設(shè)計運(yùn)行設(shè)計數(shù)據(jù)結(jié)構(gòu)設(shè)計出錯處理設(shè)計等 為詳細(xì)設(shè)計奠定基礎(chǔ)。文檔的分類6、詳細(xì)設(shè)計說明書 著重描述每一個模塊是如何實現(xiàn)的，包括實現(xiàn)算法、邏輯流程等。7、用戶手冊詳細(xì)描述軟件的功能、性能和用戶界面，使用戶了解如何使用該軟件。8、操作手冊為操作人員提供軟件各種運(yùn)行情況的有關(guān)知識，特別是操作方法細(xì)節(jié)。文檔的分類1、可行性研究報告說明該軟件項目的實現(xiàn)在技術(shù)上、經(jīng)濟(jì)上和社會因素上的可行性;評述為合理地達(dá)到開發(fā)目標(biāo)可供選擇的各種可能的實現(xiàn)方案;說明并論證所選定實施方案的理由。文檔的分類2、項目開發(fā)計劃 為軟件項目實施方案制定出的具體計劃。它包括

各部分工作的負(fù)責(zé)人員開發(fā)的進(jìn)度開發(fā)經(jīng)費(fèi)的概算所需的硬件和軟件資源等 項目開發(fā)計劃應(yīng)提供給管理部門，并作為開發(fā)階段評審的基礎(chǔ)。文檔的分類3、軟件需求說明書 對目標(biāo)軟件的功能、性能、用戶界面及運(yùn)行環(huán)境等作出詳細(xì)的說明。 它是用戶與開發(fā)人員雙方對軟件需求取得共同理解基礎(chǔ)上達(dá)成的協(xié)議，也是實施開發(fā)工作的基礎(chǔ)。4、數(shù)據(jù)要求說明書 給出數(shù)據(jù)邏輯描述和數(shù)據(jù)采集的各項要求,為生成和維護(hù)系統(tǒng)的數(shù)據(jù)文件做好準(zhǔn)備。文檔的分類5、概要設(shè)計說明書 該說明書是概要設(shè)計工作階段的成果。它應(yīng)當(dāng)說明

系統(tǒng)的功能分配模塊劃分程序的總體結(jié)構(gòu)輸入輸出及接口設(shè)計運(yùn)行設(shè)計數(shù)據(jù)結(jié)構(gòu)設(shè)計出錯處理設(shè)計等 為詳細(xì)設(shè)計奠定基礎(chǔ)。文檔的分類6、詳細(xì)設(shè)計說明書 著重描述每一個模塊是如何實現(xiàn)的，包括實現(xiàn)算法、邏輯流程等。7、用戶手冊詳細(xì)描述軟件的功能、性能和用戶界面，使用戶了解如何使用該軟件。8、操作手冊為操作人員提供軟件各種運(yùn)行情況的有關(guān)知識，特別是操作方法細(xì)節(jié)。文檔的分類9、測試計劃 針對組裝測試和確認(rèn)測試，需要為組織測試制定計劃。計劃應(yīng)包括

測試的內(nèi)容進(jìn)度安排條件人員測試用例的選取原則測試結(jié)果允許的偏差范圍等文檔的分類10、測試分析報告 測試工作完成后，應(yīng)提交測試計劃執(zhí)行情況的說明。對測試結(jié)果加以分析，并提出測試的結(jié)論性意見。11、開發(fā)進(jìn)度月報 該月報是軟件人員按月向管理部門提交的項目進(jìn)展情況的報告。報告應(yīng)包括進(jìn)度計劃與實際執(zhí)行情況的比較、階段成果、遇到的問題和解決的辦法以及下個月的打算等。文檔的分類12、項目開發(fā)總結(jié)報告軟件項目開發(fā)完成之后，應(yīng)當(dāng)與項目實施計劃對照，總結(jié)實際執(zhí)行的情況，如進(jìn)度、成果、資源利用、成本和投入的人力。還需對開發(fā)工作作出評價，總結(jié)經(jīng)驗和教訓(xùn)。文檔的分類13、維護(hù)修改建議

軟件產(chǎn)品投入運(yùn)行之后，可能有修正、更改等問題，應(yīng)當(dāng)對存在的問題、修改的考慮以及修改的影響估計等做詳細(xì)的描述，寫成維護(hù)修改建議，提交審批。以上軟件文檔是在軟件生存期中，隨著各個階段工作的開展適時編制的。其中，有的僅反映某一個階段的工作，有的則需跨越多個階段。文檔的分類軟件生存期各階段與各種文檔編制的關(guān)系文檔最終要向軟件管理部門，或向用戶回答下列問題

哪些需求要被滿足（What）；軟件在什么環(huán)境中實現(xiàn)，所需信息從哪里來（Where）；開發(fā)時間如何安排（When）；開發(fā)(或維護(hù))工作打算由誰來做（Who）；需求應(yīng)如何實現(xiàn)（How）；為什么要進(jìn)行這些軟件開發(fā)或維護(hù)修改工作（Why）。文檔要回答的問題對文檔編制的質(zhì)量要求如果不重視文檔編寫工作，或是對文檔編寫工作的安排不當(dāng)，就不可能得到高質(zhì)量的文檔。質(zhì)量差的文檔使讀者難于理解，給使用者造成許多不便會削弱對軟件的管理（難以確認(rèn)和評價開發(fā)工作的進(jìn)展情況)，提高軟件成本(一些工作可能被迫返工)造成誤操作對編制高質(zhì)量文檔的要求(1)針對性

文檔編制以前應(yīng)分清讀者對象。按不同的類型、不同層次的讀者，決定怎樣適應(yīng)他們的需要。

管理文檔主要面向管理人員

用戶文檔主要面向用戶這兩類文檔不應(yīng)像開發(fā)文檔(面向開發(fā)人員)那樣過多使用軟件的專用術(shù)語。(2)精確性

文檔的行文應(yīng)當(dāng)十分確切，不能出現(xiàn)多義性的描述。同一課題幾個文檔的內(nèi)容應(yīng)當(dāng)是協(xié)調(diào)一致，沒有矛盾的。(3)清晰性

文檔編寫應(yīng)力求簡明，如有可能，配以適當(dāng)?shù)膱D表，以增強(qiáng)其清晰性。(4)完整性任何一個文檔都應(yīng)當(dāng)是完整的、獨(dú)立的，它應(yīng)自成體系。例如，前言部分應(yīng)做一般性介紹，正文給出中心內(nèi)容，必要時還有附錄，列出參考資料等。同一課題的幾個文檔之間可能有些部分內(nèi)容相同，這種重復(fù)是必要的。

不要在文檔中出現(xiàn)轉(zhuǎn)引其它文檔內(nèi)容的情況。如，一些段落沒有具體描述，用“見××文檔××節(jié)”的方式.(5)靈活性

各個不同軟件項目，其規(guī)模和復(fù)雜程度有著許多實際差別，不能一律看待。應(yīng)根據(jù)具體的軟件開發(fā)項目，決定編制的文檔種類。軟件開發(fā)的管理部門應(yīng)該根據(jù)本單位承擔(dān)的應(yīng)用軟件的專業(yè)領(lǐng)域和本單位的管理能力，制定一個對文檔編制要求的實施規(guī)定。

對于一個具體的應(yīng)用軟件項目，項目負(fù)責(zé)人應(yīng)根據(jù)上述實施規(guī)定，確定一個文檔編制計劃。其中包括：編制哪幾種文檔，詳細(xì)程度如何各文檔的編制負(fù)責(zé)人和進(jìn)度要求審查/批準(zhǔn)負(fù)責(zé)人和時間進(jìn)度安排在開發(fā)時期內(nèi)各文檔的維護(hù)、修改和管理的負(fù)責(zé)人，以及批準(zhǔn)手續(xù)當(dāng)所開發(fā)的軟件系統(tǒng)非常大時，一種文檔可以分成幾卷編寫。例如，

項目開發(fā)計劃可分寫為：質(zhì)量保證計劃配置管理計劃用戶培訓(xùn)計劃安裝實施計劃等。

系統(tǒng)設(shè)計說明書可分寫為：系統(tǒng)設(shè)計說明書子系統(tǒng)設(shè)計說明書。

程序設(shè)計說明書可分寫為：程序設(shè)計說明書接口設(shè)計說明書版本說明。

操作手冊可分寫為：操作手冊安裝實施過程。

測試計劃可分寫為：

測試計劃

測試設(shè)計說明測試規(guī)程測試用例。

測試分析報告可分寫為：綜合測試報告驗收測試報告。

項目開發(fā)總結(jié)報告也可分寫成：項目開發(fā)總結(jié)報告資源環(huán)境統(tǒng)計。對國標(biāo)G