導航:首頁 > 軟體問題 > 軟體開發的文檔怎麼寫

軟體開發的文檔怎麼寫

發布時間:2022-12-07 11:58:48

『壹』 做軟體項目設計文檔怎麼寫啊

按照以下格式填就好了,不過是我自己寫的,有不好的地方大家互相學習修改一下~

詳細設計文檔規范
1.0概述
這部分提供對整個設計文檔的概述。描述了所有數據,結構,介面和軟體構件級別的設計。
1.1 目標和對象
描述軟體對象的所有目標。
1.2 陳述范圍
軟體描述。主要輸入,過程功能,輸出的描述,不考慮詳細細節。
1.3 軟體內容
軟體被置於商業或者產品線中,討論相關的戰略問題。目的是讓讀者能夠對「宏圖」有所了解。
1.4 主要系統參數
任何商務軟體或者產品線都包含軟體規定、設計、實現和測試的說明和規范。
2.0 數據設計
描述所有數據結構包括內部變數,全局變數和臨時數據結構。
2.1 內部軟體數據結構
描述軟體內部的構件之間的數據傳輸的結構。
2.2 全局數據結構
描述主要部分的數據結構。
2.3 臨時數據結構
為臨時應用而生成的文件的描述。
2.4 資料庫描述
作為應用程序的一部分,描述資料庫結構。
3.0 結構化和構件級別設計
描述程序結構。
3.1 程序結構
詳細描述應用程序所選定的程序結構。
3.1.1 結構圖
圖形化描述結構。
3.1.2 選擇性
討論其它可供考慮的結構。選定3.1.1中結構類型的原因。
3.2 構件描述
詳細描述結構中的每個軟體構件。
3.2.1 構件過程敘述(PSPEC)
描述構件的過程。
3.2.2 構件介面描述
詳細描述構件的輸入和輸出。
3.2.3 構件執行細節
每個構件的詳細演算描述。
3.2.3.1 介面描述
3.2.3.2 演算模型(e.g., PDL)
3.2.3.3 規范/限制
]3.2.3.4 本地數據結構
3.2.3.5 在3.2.3.6設計中包含的執行結果
3.3 軟體介面描述
軟體對外界的介面描述
3.3.1機器對外介面
與其他機器或者設備的介面描述。
3.3.2系統對外介面
對其它系統、產品和網路的介面描述。
3.3.3與人的介面
概述軟體與任何人的界面。
4.0 用戶界面設計
描述軟體的用戶界面設計。
4.1 描述用戶界面
詳細描述用戶界面,包括屏幕顯示圖標、圖片或者類型。
4.1.1 屏幕圖片
從用戶角度描述界面。
4.1.2 對象和操作
所有屏幕對象和操作的定義。
4.2 界面設計規范
用戶界面的設計和實現的規范和標准。
4.3 可見構件
實現的GUI可見構件說明。
4.4 UIDS描述
用戶界面開發系統描述。
5.0約束、限制和系統參數
會影響軟體的規格說明、設計和實現的特殊事件。
6.0測試標准
測試策略和預備測試用例描述。
6.1 測試的類別
規定實施測試的類別,包括盡量詳細的描述。這里是針對黑盒測試現象的描述。
6.2期待軟體反饋
測試期待的結果描述。
6.3執行界線
特殊執行需要的說明。
6.4 重要構件確認
決定性構件或者需要特殊注意的構件的測試確認。
7.0附錄
設計說明的補充信息。
7.1系統可跟蹤矩陣
一個定期回歸系統規格跟蹤軟體需求的矩陣。
7.2 產品戰略
如果規格說明書是為一個產品設計的,描述相關的產品戰略。
7.3 使用分析演算法
描述所有分析活動所使用到的分析演算法。
7.4 補充信息 (如果有需要特別說明的)

『貳』 怎麼寫項目開發的文檔

軟體開發中文檔的編寫是一個不可缺少的環節,常見的如《需求分析》、《概要分析》、《資料庫設計》等。在「軟體人」的陣營里向來存在兩種觀點,注重文檔還是關心代碼。

『叄』 軟體開發設計文檔怎麼寫

首先是需求調研,項目背景調研。設計文檔有概要設計詳細設計,概要設計需要先定邊界,邊界定好在根據對應功能做詳細設計,詳細設計就是把概要中的功能點單獨羅列出來做功能點設計比如:輸入什麼值,如何校驗

『肆』 軟體文檔怎麼寫

1.0概述 這部分提供對整個設計文檔的概述。描述了所有數據,結構,介面和軟體構件級別的設計。

1.1 目標和對象 描述軟體對象的所有目標。

1.2 陳述范圍 軟體描述。主要輸入,過程功能,輸出的描述,不考慮詳細細節。

1.3 軟體內容 軟體被置於商業或者產品線中,討論相關的戰略問題。目的是讓讀者能夠對「宏圖」有所了解。

1.4 主要系統參數 任何商務軟體或者產品線都包含軟體規定、設計、實現和測試的說明和規范。

2.0 數據設計 描述所有數據結構包括內部變數,全局變數和臨時數據結構。

2.1 內部軟體數據結構 描述軟體內部的構件之間的數據傳輸的結構。

2.2 全局數據結構 描述主要部分的數據結構。

2.3 臨時數據結構 為臨時應用而生成的文件的描述。

2.4 資料庫描述 作為應用程序的一部分,描述資料庫結構。

3.0 結構化和構件級別設計 描述程序結構。

3.1 程序結構 詳細描述應用程序所選定的程序結構。

3.1.1 結構圖 圖形化描述結構。

3.1.2 選擇性 討論其它可供考慮的結構。選定3.1.1中結構類型的原因。

3.2 構件描述 詳細描述結構中的每個軟體構件。

3.2.1 構件過程敘述(PSPEC) 描述構件的過程。

3.2.2 構件介面描述 詳細描述構件的輸入和輸出。

3.2.3 構件執行細節 每個構件的詳細演算描述。

3.2.3.1 介面描述

3.2.3.2 演算模型(e.g., PDL)

3.2.3.3 規范/限制 ]

3.2.3.4 本地數據結構

3.2.3.5 在3.2.3.6設計中包含的執行結果

3.3 軟體介面描述 軟體對外界的介面描述

3.3.1機器對外介面 與其他機器或者設備的介面描述。

3.3.2系統對外介面 對其它系統、產品和網路的介面描述。

3.3.3與人的介面 概述軟體與任何人的界面。

4.0 用戶界面設計 描述軟體的用戶界面設計。

4.1 描述用戶界面 詳細描述用戶界面,包括屏幕顯示圖標、圖片或者類型。

4.1.1 屏幕圖片 從用戶角度描述界面。

4.1.2 對象和操作 所有屏幕對象和操作的定義。

4.2 界面設計規范 用戶界面的設計和實現的規范和標准。

4.3 可見構件 實現的GUI可見構件說明。

4.4 UIDS描述 用戶界面開發系統描述。

5.0約束、限制和系統參數 會影響軟體的規格說明、設計和實現的特殊事件。

6.0測試標准 測試策略和預備測試用例描述。

6.1 測試的類別 規定實施測試的類別,包括盡量詳細的描述。這里是針對黑盒測試現象的描述。

6.2期待軟體反饋 測試期待的結果描述。

6.3執行界線 特殊執行需要的說明。

6.4 重要構件確認 決定性構件或者需要特殊注意的構件的測試確認。

7.0附錄 設計說明的補充信息。

7.1系統可跟蹤矩陣 一個定期回歸系統規格跟蹤軟體需求的矩陣。

7.2 產品戰略 如果規格說明書是為一個產品設計的,描述相關的產品戰略。

7.3 使用分析演算法 描述所有分析活動所使用到的分析演算法。

7.4 補充信息 (如果有需要特別說明的)

『伍』 我該怎麼寫詳細開發文檔

以下nbsp;是我們單位的nbsp;項目開發計劃書nbsp;希望對你有幫助編制項目開發計劃的目的是用文件的形式,把對於在開發過程中各項工作的負責人員、開發進度、nbsp;所需經費預算、所需軟、硬體條件等問題作出的安排記載下來,以便根據本計劃開展和檢查本項目的開nbsp;發工作。編制內容要求如下:nbsp;nbsp;nbsp;nbsp;1nbsp;引言nbsp;nbsp;nbsp;1.1編寫目的nbsp;nbsp;nbsp;nbsp;說明編寫這份項目開發計劃的目的,並指出預期的讀者。nbsp;nbsp;nbsp;1.2背景nbsp;nbsp;nbsp;說明:nbsp;nbsp;nbsp;a.待開發的軟體系統的名稱;nbsp;nbsp;nbsp;b.本項目的任務提出者、開發者、用戶及實現該軟體的計算中心或計算機網路;nbsp;nbsp;nbsp;C.該軟體系統同其他系統或其他機構的基本的相互來往關系。nbsp;nbsp;nbsp;1.3定義nbsp;nbsp;nbsp;nbsp;列出本文件中用到的專門術語的定義和外文首字母組詞的原片語。nbsp;nbsp;nbsp;1.4參考資料nbsp;nbsp;nbsp;列出用得著的參考資料,如:nbsp;nbsp;nbsp;a.本項目的經核準的計劃任務書或合同、上級機關的批文;nbsp;nbsp;nbsp;b.屬於本項目的其他已發表的文件;nbsp;nbsp;nbsp;C.本文件中各處引用的文件、資料,包括所要用到的軟體開發標准。nbsp;列出這些文件資料的標題、文件編號、發表日期和出版單位,說明能夠得到這些文件資料的來源。nbsp;nbsp;nbsp;2nbsp;項目概述nbsp;nbsp;nbsp;nbsp;2.1nbsp;工作內容nbsp;nbsp;nbsp;簡要地說明在本項目的開發中須進行的各項主要工作。nbsp;nbsp;nbsp;2.2主要參加人員nbsp;nbsp;nbsp;扼要說明參加本項目開發工作的主要人員的情況,包括他們的技術水平。nbsp;nbsp;nbsp;nbsp;2.3產品nbsp;nbsp;nbsp;2.3.1程序nbsp;nbsp;nbsp;列出需移交給用戶的程序的名稱、所用的編程語言及存儲程序的媒體形式,並通過引用有關文件,逐項說明其功能和能力。nbsp;nbsp;nbsp;nbsp;2.3.2文件nbsp;nbsp;nbsp;列出需移交給用戶的每種文件的名稱及內容要點。nbsp;nbsp;nbsp;nbsp;2.3.3服務nbsp;nbsp;nbsp;列出需向用戶提供的各項服務,如培訓安裝、維護和運行支持等,應逐項規定開始日期、所提供支持nbsp;的級別和服務的期限。nbsp;nbsp;nbsp;2.3.4非移交的產品nbsp;nbsp;nbsp;nbsp;說明開發集體應向本單位交出但不必向用戶移交的產品(文件甚至某些程序)。nbsp;nbsp;nbsp;2.4驗收標准nbsp;nbsp;nbsp;nbsp;對於上述這些應交出的產品和服務,逐項說明或引用資料說明驗收標准。nbsp;nbsp;nbsp;nbsp;2.5完成項目的員遲用限nbsp;nbsp;nbsp;nbsp;2.6本計劃的批准者和批准日期nbsp;nbsp;nbsp;nbsp;3nbsp;實施計劃nbsp;nbsp;nbsp;nbsp;3.1工作任務的分門與人員分工nbsp;nbsp;軟體開發網nbsp;www.mscto.comnbsp;nbsp;對於項目開發中需完成的各項工作,從需求分析、設計、實現、測試直到維護,包括文件的編制、審批、列印、分發工作,用戶培訓工作,軟體安裝工作等,按層次進行分解,指明每項任務的負責人和參加人員。nbsp;nbsp;nbsp;3.2nbsp;介面人員nbsp;nbsp;nbsp;說明負責介面工作的人員及他們的職責,包括:nbsp;nbsp;nbsp;anbsp;.負責本項目同用戶的介面人員;nbsp;nbsp;nbsp;b.負責本項目同本單位各管理機構,如合同計劃管理部門、財務部門、質量管理部門等的介面人員;nbsp;nbsp;nbsp;nbsp;c.負責本項目同各分合同負責單位的介面人員等。nbsp;nbsp;nbsp;nbsp;3.3進度nbsp;nbsp;nbsp;nbsp;對於需求分析、設計、編碼實現、測試、移交、培訓和安裝等工作,給出每項工作任務的預。定開始日期、完成日期及所需資源,規定各項工作任務完成的先後順序以及表徵每項工作任務完成的標志性事件(即所謂「里程碑「)。nbsp;nbsp;nbsp;nbsp;3.4預算nbsp;nbsp;nbsp;nbsp;逐項列出本開發項目所需要的勞務(包括人員的數量和時間)以及經費的預算(包括辦公費、差旅費、機時費、資料費、通訊設備和專用設備的租金等)和來源。nbsp;nbsp;nbsp;3.5關鍵問題nbsp;nbsp;nbsp;逐項列出能夠影響整個項目成敗的關鍵問題、技術難點和風險,指出這些問題對項目的影響。nbsp;[Page]nbsp;nbsp;nbsp;4nbsp;支持條件nbsp;nbsp;nbsp;說明為支持本項目的開發所需要的各種條件和設施。nbsp;nbsp;nbsp;4.1計算機系統支持nbsp;nbsp;nbsp;逐項列出開發中和運行時所需的計算機系統支持,包括計算機、外圍設備、通訊設備、模擬器、編譯nbsp;(或nbsp;匯編)程序、操作系統、數據管理程序包、數據存儲能力和測試支持能力等,逐項給出有關到貨日期、nbsp;使用時間的要求。nbsp;nbsp;nbsp;4.2需由用戶承擔的工作nbsp;nbsp;nbsp;逐項列出需要用戶承擔的工作和完成期限。包括需由用戶提供的條件及提供時間。nbsp;nbsp;nbsp;4.3由外單位提供的條件nbsp;nbsp;nbsp;nbsp;逐項列出需要外單位分合同承包者承擔的工作和完成的時間,包括需要由外單位提供的條件和提nbsp;供的時間。nbsp;nbsp;nbsp;nbsp;5nbsp;專題計劃要點nbsp;nbsp;nbsp;說明本項目開發中需制

『陸』 android技術開發文檔怎麼寫

:軟體需求文檔格式的標准寫法 1.引言 1.1 編寫目的 · 闡明開發本軟體的目的; 1.2 項目背景 · 標識待開發軟體產品的名稱、代碼; · 列出本項目的任務提出者、項目負責人、系統分析員、系統設計員、程序設計員、程序員、資料員以及與本項目開展

『柒』 軟體開發文檔怎麼寫

這要看你的文檔是基於什麼用途的銷售用途:要有產品白皮書,產品未來方向報告,使用性能報告,兼容性報告,產品演示文稿說明設計用途的。產品功能需求文件,產品的底層設計,產品詳細設計內容。產品用途的。產品目錄,自訴文件,幫助文件,使用手冊,產品授權書。客服用途。已知問題列表,常見問題解答,危機處理指南,問題診斷指南。有個模板可以看下國家標准軟體開發文檔模板GB856T http://www.cndzz.com/down/down.asp?id=65584&no=1

『捌』 如何學習寫程序設計文檔

寫程序設計文檔,要注意簡潔和邏輯性,需要明確的是:文檔並不是進行設計的目標,也不是設計過程中額外的工作。具體模塊和步驟為:

1.需求分析
需求分析的結果通常需要使用需求說明文檔來描述,目前主流的需求描述方法包括:用戶例圖、用戶故事等方式。這些方式有所不同的側重,其核心思想就是描述清楚用戶的使用場景。

2.功能設計
對於主要是用戶界面的軟體項目來說,功能設計可以看作是畫出原型界面,描述使用場景,獲得用戶認可的過程。而對於沒有界面的軟體項目來說,則功能設計與需求分析的區分更為模糊。

3.系統架構設計
系統架構設計是一個非常依賴於經驗的設計過程。需要根據軟體項目的特定功能需求和非功能性需求進行取捨,最終獲得一個滿足各方要求的系統架構。系統架構的不同,將很大程度上決定系統開發和維護是否能夠較為容易的適應需求變化,以及適應業務規模擴張。

4.模塊/子系統概要設計
模塊/子系統的概要設計,由架構師參與,核心設計和開發人員負責的方式進行。
在概要設計工作中,需要在架構確定的開發路線的指導下,完成模塊功能實現的關鍵設計工作。在概要設計階段,需要關注於模塊的核心功能和難點進行設計。
5.模塊詳細設計
在瀑布式開發模型中,模塊的詳細設計會要求比較嚴格,將所有類進行詳細設計。除了一些對於系統健壯性要求非常嚴格的軟體項目,如國防項目,金融項目還要求有詳細設計文檔之外。其他的項目大多採用其他方式來處理這樣的工作,如自動化測試等。

綜上所述,軟體設計文檔作為軟體開發團隊的溝通、理解、知識共享的手段,具有非常重要的意義。

『玖』 軟體開發需要編寫哪些文檔

這個問題沒有一定的,因為這里有多種因素
如,開發階段、文檔化要求程度等,若是通過CMM評估的,文檔就較多

一般的是按項目開發過程來分,基本的有
可行性研究報告(若是一個新項目且未確定的或應客戶要求時需要,實際上大部份公司很少有這文檔)
用戶需求說明書(用戶+開發人員共同確認)
軟體需求規格說明書
設計說明書(體系結構、詳細設計)
測試用例
用戶手冊
實現代碼

這些文檔中,包括一定的分析與設計圖形,如用例圖、資料庫結構、ER圖等
當然項目計劃、測試計劃也應算在內

其它的(如CMM要求的)
風險、估算方面的,質量保證方面的、配置管理方面、定義的模板、度量資料庫等
具體需要多少文檔就是要看項目實際

這方面的東西,可參考一些軟體工程類的書

『拾』 軟體開發文檔應該如何寫

如果我們知道軟體文檔的價值,那麼為什麼不經常使用它呢?對於新手,大多數軟體文檔都存在很多下面提到的這些問題:

· 糟糕的語法和/或拼寫錯誤的詞語

· 不完整

· 過期或不準確

· 篇幅太長

http://www.mscto.com

· 首字母縮寫沒有解釋或術語不專業

http://www.mscto.com

· 難於找到信息或在文檔中定位 軟體開發網

存在這些問題的主要原因是軟體文檔通常沒有被給予足夠的重視。項目預算被迫將主要活動花在了開發工作上,在那裡管理層很容易看到他們的收益。值得投入成本的文檔工作通常都是主觀的,而且通常被刻畫為需要避免的成本,因為它們被認為不能產生投資回報(ROI)。很多項目經理將客戶所需要的最少文檔看作是「鍍金」。

軟體開發網

軟體文檔的另外一個麻煩來源是文檔的作者。很多應用程序開發經理覺得軟體文檔是開發工作的一個標准部分,因此,要求他們的開發人員在編碼時也編寫軟體文檔。

雖然這在理論上是說得過去的,但是不應該將開發人員看成文檔作者。很簡單,技術人員只被培訓如何開發,而沒有被培訓如何寫文檔。為了解決這一問題,很多應用程序開發經理嘗試通過聘請一些技術性寫手或商業分析人員來提高他們的軟體文檔的質量。這就導致出現了一個相反的問題:技術寫手和商業分析人員通常只有有限的技術技能。

解決方案依賴於文檔,文檔應該迎合其潛在讀者的口味。這方面的通用規則是要求使用一個協同工作方法來編寫文檔,這種方法允許開發人員和寫手發揮他們的長處。例如,如果潛在的讀者是系統設計人員,那麼開發人員應該提供詳細的輸入,但是允許技術寫手去組織和編輯內容以使文檔符合語法。

不管潛在的讀者還是被選中的讀者,軟體文檔的質量與其可使用性相關,以下六個屬性可以用來測量軟體文檔的可使用性:

· 適用性:文檔提供了相關的信息嗎?

· 合時性:文檔所提供的是當時的信息嗎?

· 正確性:文檔所提供的信息正確嗎?

· 完整性:文檔是不是足夠詳細?

· 可用性:文檔隨手可用嗎?

· 可使用性:能夠快速直觀地找

希望能助你一臂之力

閱讀全文

與軟體開發的文檔怎麼寫相關的資料

熱點內容
電腦上怎麼下載班智達的軟體 瀏覽:1150
無痕跡消除圖片軟體 瀏覽:715
免費小票軟體 瀏覽:948
華為在哪裡設置軟體停止運行 瀏覽:956
用電腦鍵盤調節聲音大小 瀏覽:1253
自動刷軟體賺錢 瀏覽:1256
古裝連續劇免費版 瀏覽:1409
工免費漫畫 瀏覽:1141
手機軟體專門儲存文件 瀏覽:1503
uos如何用命令安裝軟體 瀏覽:1310
有線耳機插電腦麥克風 瀏覽:642
侏羅紀世界3在線觀看完整免費 瀏覽:990
單個軟體怎麼設置名稱 瀏覽:715
鳳凰網電腦版下載視頻怎麼下載視頻怎麼下載 瀏覽:1380
明白之後如何免費獲得無人機 瀏覽:827
如何解禁軟體菜單 瀏覽:845
副路由器連接電腦視頻 瀏覽:1346
內置wifi電視如何裝軟體 瀏覽:1095
手機換零免費雪碧 瀏覽:1583
國行蘋果如何下載美版軟體 瀏覽:1202