項目開發(fā)文檔編寫規(guī)范

時間：2023-05-16 20:57:02 | 來源：網(wǎng)站運營

時間：2023-05-16 20:57:02 來源：網(wǎng)站運營

項目開發(fā)文檔編寫規(guī)范：前言

在開發(fā)項目的過程中，我深刻的意識到，文檔存在的意義并不是無用的報告，簡潔明了的文檔不光能記錄你當(dāng)下所做的，還能在繁重的工作中分神思考下一步該做什么時為你節(jié)約精力，并且在項目周期內(nèi)，使整個項目保持一致性。所以，軟件開發(fā)文檔的編寫是很有必要的。我參考網(wǎng)上的資料，結(jié)合自己項目開發(fā)時的心得，分享一些經(jīng)驗。




文檔類型

在項目開發(fā)過程中，應(yīng)該按要求編寫好十三種文檔，文檔編寫要求具有針對性、精確性、清晰性、完整性、靈活性、可追溯性。同時依照項目人員的角色劃分，完成不同類型的文檔。以下排序并未嚴(yán)格按照時間排序。










類型說明

可行性分析報告（產(chǎn)品人員）

可行性研究報告的編寫目的是：說明該軟件開發(fā)項目的實現(xiàn)在技術(shù)、經(jīng)濟和社會條件方面的可行性；評述為了合理達到開發(fā)目標(biāo)而可能選擇的各種方案；實施方案的利弊；說明并論證所選定的方案。




項目開發(fā)計劃（產(chǎn)品人員）

軟件項目開發(fā)計劃即為軟件項目實施方案制定出的具體計劃。項目開發(fā)計劃應(yīng)提前給管理部門，并作為開發(fā)階段評審的基礎(chǔ)。編寫項目開發(fā)計劃的目的是用文件的形式，把對于在開發(fā)過程中各項工作的負責(zé)人員、開發(fā)進度、所需經(jīng)費預(yù)算、所需的軟硬條件等問題做出的安排記載下來，以便根據(jù)本計劃開展和檢查項目的開發(fā)工作。




軟件需求說明書（產(chǎn)品人員）

軟件需求說明書也稱為軟件規(guī)格說明。該說明書對所開發(fā)軟件的功能、性能、用戶界面及運行環(huán)境等做出詳細的說明。它是用戶與開發(fā)人員雙方對軟件需求取得共同理解基礎(chǔ)上達成的協(xié)議，也是實施開發(fā)工作的基礎(chǔ)。軟件需求說明書的編寫目的就是為了使用戶和軟件開發(fā)者雙方對該軟件的初需求有一個共同的理解，并使之成為整個開發(fā)工作的基礎(chǔ)。




概要設(shè)計說明書 （開發(fā)人員）

概要設(shè)計說明書又可稱系統(tǒng)設(shè)計說明書，這里所說的系統(tǒng)是指程序系統(tǒng)。編寫的目的是說明對程序系統(tǒng)的設(shè)計考慮，包括程序系統(tǒng)的基本處理。流程、程序系統(tǒng)的組織結(jié)構(gòu)、模塊劃分、功能分配、接口設(shè)計。運行設(shè)計、數(shù)據(jù)結(jié)構(gòu)設(shè)計和出錯處理設(shè)計等，為程序的詳細設(shè)計提供基礎(chǔ)。




詳細設(shè)計規(guī)格說明書（開發(fā)人員）

詳細設(shè)計說明書又可稱程序設(shè)計說明書。編寫目的是說明一個軟件系統(tǒng)各個層次中的每一個程序（每人模塊或子程序）的設(shè)計考慮。如果項目比較簡單，層次較少，本文件可以不單獨編寫，有關(guān)內(nèi)容合并入概要設(shè)計說明書。




用戶操作手冊（產(chǎn)品人員）

用戶操作手冊的編寫是要使用非專門術(shù)語的語言，充分地描述該軟件系統(tǒng)所具有的功能及基本的使用方法，提供該軟件每一個運行的具體過程和有關(guān)知識，包括操作方法的細節(jié)。使用戶（或潛在用戶）通過本手冊能夠了解該軟件的用途，并且能夠確定在什么情況下，如何使用它。




測試計劃（測試人員）

測試計劃是軟件項目實施計劃中的一項重要的內(nèi)容，應(yīng)當(dāng)在軟件開發(fā)初期、即需求分析階段制訂。測試計劃應(yīng)當(dāng)定義被測試對象和測試目標(biāo)，確定測試階段和測試周期的劃分；制訂測試人員、軟硬件資源和測試進度等方面的計劃，規(guī)定軟件測試方法，測試標(biāo)準(zhǔn)以及支持環(huán)境和測試工具。針對子系統(tǒng)在特定的測試階段所要進行的測試工作制訂詳細計劃，它詳細說明規(guī)定了測試小組的各項測試任務(wù)，測試策略、任務(wù)分配和進度安排等。




測試分析報告（測試人員）

測試工作完成以后，應(yīng)當(dāng)提交測試計劃情況說明書，對測試結(jié)果加以分析，并提出測試的結(jié)論性意見。




開發(fā)進度月報（開發(fā)人員）

開發(fā)進度月報的編寫目的是及時向有關(guān)部門匯報項目開發(fā)的進度和情況，以便及時發(fā)現(xiàn)和處理開發(fā)過程中出現(xiàn)的問題，一般，開發(fā)進度月報是以項目組單位每月編寫的。如果被開發(fā)的軟件系統(tǒng)規(guī)模比較大，整個工程項目被劃分給若干個分項目駔承擔(dān)，開發(fā)進度月報將以分項目為單位每月編寫。




項目開發(fā)總結(jié)報告（產(chǎn)品人員）

軟件項目開發(fā)完成之后，應(yīng)當(dāng)與項目實施計劃對照，總結(jié)實際執(zhí)行的情況，如進度、成果、資源利用、成本和投入的人力。此外，還需對開發(fā)工作做出評價，總結(jié)經(jīng)驗和教訓(xùn)。項目開發(fā)總結(jié)報告的編寫是為了總結(jié)本項目開發(fā)工作的經(jīng)驗，說明實際取得的開發(fā)結(jié)果以及對整個開發(fā)工作的各個方面的評價。




軟件維護手冊（開發(fā)人員）

主要包括軟件系統(tǒng)說明、程序模塊說明、操作環(huán)境、支持軟件的說明、維護 過程的說明，便于軟件的維護。




軟件問題報告（測試人員）

指出軟件問題的登記情況，如日期、發(fā)現(xiàn)人、狀態(tài)、問題所屬模塊等，為軟件修改提供準(zhǔn)備文檔。




軟件修改報告（開發(fā)人員）

軟件產(chǎn)品投入運行以后，發(fā)現(xiàn)了需對其進行修正、更改等問題，應(yīng)將存在的問題、修改的考慮以及修改的影響作出詳細的描述，提交審批。




總結(jié)

根據(jù)項目的規(guī)模大小，以及人員構(gòu)成，對所需要的文檔進行編寫，將大大提高項目開發(fā)的效率及規(guī)范程度。

————————————————

版權(quán)聲明：本文為CSDN博主「夏洛克卷」的原創(chuàng)文章，遵循 CC 4.0 BY-SA 版權(quán)協(xié)議，轉(zhuǎn)載請附上原文出處鏈接及本聲明。

原文鏈接：CSDN-專業(yè)IT技術(shù)社區(qū)-登錄