一個系統(tǒng)的軟件詳細設計說明書應該怎么寫？

時間：2023-12-06 13:24:01 | 來源：網(wǎng)站運營

時間：2023-12-06 13:24:01 來源：網(wǎng)站運營

一個系統(tǒng)的軟件詳細設計說明書應該怎么寫？：

?一、前言

我們在平常工作中可能會遇到這樣的場景，領導跟你講了我們這個產(chǎn)品大概要做成啥樣，然后畫了一張簡圖，就將任務給你，開始出方案設計，需求設計，架構設計，這個時候很多人往往會無從下手。 最近也算是從0開始寫了新平臺的任務設計書，有一些感受分享下。

二、進入新行業(yè)如何進行快速充電

1、同事領導學習

新進入一個行業(yè)，你的同事可能比你更加了解這個行業(yè)，所以需要向他們學習，而你的領導肯定是比你了解這個行業(yè)的，所以向領導同事多學習。沒事找同事聊聊天，找領導請教請教，對快速進入新行業(yè)是很有作用的。

2、關注行業(yè)自媒體

可以在微信公眾號關注一些行業(yè)公眾號，很多行業(yè)都會有行業(yè)協(xié)會之類的公眾號，這種公眾號上面的行業(yè)資訊是比較多的，還可以關注行業(yè)頭部企業(yè)的公眾號，比如新能源就可以關注寧德時代官方公眾號。 還可以去本站關注行業(yè)的大V，這個很簡單，去本站搜索一下就有了，而且經(jīng)常關注類似話題，本站也會給你推薦這方面的內(nèi)容。 B站上可以找免費的課程學習。 行業(yè)的論壇，能參加的就參加，參加不了的，可以通過線上的方式或者其他渠道掌握行業(yè)一手資訊。

3、適當購買書籍

我的前老板，也是剛進到一個新行業(yè)，她就買了大量的書籍，然后加班加點的在看，不管是從提高認知還是對業(yè)務的理解成長是非?？斓模晕医ㄗh，新進入一個行業(yè)，可以多看一些這方面的書籍，并做好總結(jié)記錄，最好能形成自己的文檔沉淀。

4、多參加相關會議

部門會議，項目會議，在不影響本職工作的前提下能參加就去參加，哪怕不發(fā)言，就聽一些你聽不懂的技術點，記錄下來，哪里不懂就問請教別人，做好會議記錄，多記，多問，多總結(jié)。

5、多與同行學習

可以進入同行交流學習群，了解動態(tài)，也可以避免一些別人已經(jīng)踩過的坑。

三、任務書整體框架

1、基本信息 2、背景與目標 3、總體設計要求 4、硬件方案設計 5、軟件方案設計 6、應用場景 7、關鍵節(jié)點及費用預算

四、基本信息

展現(xiàn)方案的版本、方案編寫時間、撰寫人員、評估手段和適用范圍

五、背景與目標

背景最好講一下行業(yè)背景和項目背景，包括行業(yè)現(xiàn)狀和面臨的問題，針對這些問題，你的目標是什么？目標寫完后，講一下項目的狠心價值是什么。 存在問題這里可以用一些深刻的圖片來說明問題。

六、總體設計要求

大體的講一下總體設計的要求，可以用大圖表現(xiàn)更清晰，講一講平臺的特性。 1、軟件項目的開發(fā)實施過程管理要求 包含總體要求和軟件變更要求及實施里程碑控制

七、硬件方案設計

1、預估下數(shù)據(jù)存儲量

評估的方案 每個行業(yè)不一樣，可進行有效性評估

2、服務器選型

2.1、服務器上運行的應用

2.2、需要支持的用戶訪問數(shù)量

預計將有多少個注冊用戶，正常情況下多少個用戶會同時在線訪問，每天同時在線訪問的最高峰值大概是多少個，未來的用戶增長情況如何。

2.3、需要存儲數(shù)據(jù)的空間大小

2.4、服務器參數(shù)

2.5、物理服務器對比

2.5.1、塔式服務器 優(yōu)勢： 主板擴展性較強，插槽很多，成本較低，性能能滿足大部分中小企業(yè)用戶的需求。 局限性： 個體較大，占用空間多，不便管理，噪音大 適用場景： 可以用于公司內(nèi)部測試環(huán)境




2.5.2、機架式服務器 優(yōu)勢： 節(jié)省空間，便于統(tǒng)一管理 局限性： 擴充性受限制，散熱性能，單機性能比較有限，價格貴于塔式服務器 適用場景： 服務器數(shù)量較多的大型企業(yè)適用，密集部署需求




2.5.3、刀片式服務器 優(yōu)勢： 節(jié)省空間，便于集中管理 局限性： 散熱問題，價格貴 適用場景： 特殊應用行業(yè)和高密度計算機環(huán)境適用，大型數(shù)據(jù)中心

2.6、云服務器對比

云服務器目前主流有阿里云、騰訊云、華為云，針對這三家做一下綜合對比。

價格對比：




選擇對比圖表

2.7、物理服務器何云服務器對比

2.8、服務器選型的方案

這里最終確認最終服務器選型的方案

八、軟件方案設計

1、綜合描述

介紹用戶類和特性、運行環(huán)境、設計和實現(xiàn)上的限制

2、外部接口需求

這里主要描述用戶界面、軟件接口、通訊接口等信息

3、系統(tǒng)功能需求

描述說明和優(yōu)先級、功能需求效果圖、激勵／響應序列、輸入/輸出數(shù)據(jù)，可以適當用圖畫出

4、其他非功能的需求

性能需求：

安全措施需求：




軟件的質(zhì)量屬性：

業(yè)務規(guī)則和用戶文檔的描述。

5、數(shù)據(jù)定義

進行數(shù)據(jù)的定義

6、分析模型

可以通過模型進行分析

7、軟件的概要設計

描述軟件概要設計

8、軟件的詳細設計

如果概要設計無法滿足的需要進行軟件的詳細設計

9、軟件的編碼

為了提高編程實現(xiàn)的質(zhì)量，軟件的程序設計必須遵照國家頒布的相關編程規(guī)范。 主要內(nèi)容包括：規(guī)范化的程序內(nèi)部文檔、數(shù)據(jù)結(jié)構的詳細說明、清晰的語句結(jié)構、編碼規(guī)范。編碼規(guī)范的內(nèi)容包括命名規(guī)范、界面規(guī)范、提示及幫助信息規(guī)范、熱鍵定義等。 在軟件編碼的同時應進行單元測試。

10、軟件的測試

為了盡早發(fā)現(xiàn)軟件產(chǎn)品中的錯誤，從而達到提高軟件質(zhì)量、降低軟件維護的費用，開發(fā)者應在編碼過程中對各個模塊的程序代碼進行單元測試，系統(tǒng)集成時進行集成測試，系統(tǒng)集成完成后對整個軟件進行系統(tǒng)測試。單元測試是在軟件開發(fā)過程中針對程序模塊進行正確性檢驗。集成測試是在單元測試的基礎上，將所有模塊按照設計要求組裝成系統(tǒng)或子系統(tǒng)，對模塊組裝過程和模塊接口進行正確性檢驗。軟件系統(tǒng)測試不僅是檢測軟件的整體行為表 現(xiàn)，從另一個側(cè)面看，也是對軟件開發(fā)設計的再確認。進行軟件系統(tǒng)測試工作時。測試主要包括界面測試、可用性測試、功能測試、穩(wěn)定性(強度)測試、性能測試、強壯性(恢復)測試、邏輯性測試、破壞性測試、安全性測試等。 開發(fā)者針對單元測試，集成測試，系統(tǒng)測試分別制定《測試計劃》。集成測試需要根據(jù)需求分析報告和概要設計制作測試用例，并須經(jīng)過評審。軟件測試按照《測試計劃》、《需求分析報告》的要求進行，最后形成《軟件測試報告》。

11、軟件的交付準備

可以寫交付清單： 在軟件測試證明軟件達到要求后，軟件開發(fā)者應向公司提交開發(fā)的目標安裝程序、數(shù)據(jù)庫的數(shù)據(jù)字典、《用戶安裝手冊》、《用戶使用指南》、需求報告、設計報告、測試報告等雙方合同約定的產(chǎn)物。 《用戶安裝手冊》應詳細介紹安裝軟件對運行環(huán)境的要求、安裝軟件的定義和內(nèi)容、在客戶端、服務器端及中間件的具體安裝步驟、安裝后的系統(tǒng)配置。 《用戶使用指南》應包括軟件各項功能的使用流程、操作步驟、相應業(yè)務介紹、特殊提示和注意事項等方面的內(nèi)容，在需要時還應舉例說明

12、軟件的鑒定驗收

在軟件開發(fā)完成后，為了確保軟件是按照需求分析的要求進行開發(fā)的，保證軟件產(chǎn)品的質(zhì)量，需要對軟件產(chǎn)品進行鑒定驗收。在開發(fā)者如期交付軟件后，由公司大數(shù)據(jù)中心負責確定具體的鑒定驗收日期。 驗收的具體內(nèi)容： 驗收內(nèi)容應該包括：合法性檢查、文檔檢查、軟件一致性檢查、軟件系統(tǒng)測試與測試結(jié)果評審等幾項工作。 合法性檢查檢查軟件開發(fā)工具是否合法、使用的函數(shù)庫、控件、組件是否有合法的發(fā)布許可。 文檔檢查檢查開發(fā)者提交的文檔必須齊全，質(zhì)量是否過關。需要開發(fā)者提供的文檔包括： 項目實施計劃； 詳細技術方案； 軟件需求規(guī)格說明書(STP)(含數(shù)據(jù)字典)； 詳細設計說明書(DDD)(含數(shù)據(jù)庫設計說明書)； 軟件測試報告(STR)； 用戶手冊(SUM)(含操作、使用、維護、應急處理手冊)； 源程序(SCL)(不可修改的電子文檔)； 軟件質(zhì)量保證計劃(SQAP)； 此外，驗收組可以根據(jù)需要對其它文檔(如軟件配置計劃、項目進展報表、階段評審報 表等)進行檢查。 文檔的質(zhì)量根據(jù)完備性、正確性、簡明性、可追蹤性、自說明性、規(guī)范件等方面進行蹤合評定。 驗收需要對軟件代碼進行檢查，以確保其符合規(guī)范，并檢查其一致性。

13、軟件的培訓

包含系統(tǒng)應用培訓和系統(tǒng)管理培訓

九、應用場景

詳細介紹項目的應用場景，可以圖文的方式進行描述。

十、關鍵節(jié)點及費用預算

項目的關鍵節(jié)點可以采用甘特圖的方式，也可以直接在語雀上云時間節(jié)點進行編輯 費用預算做的細一些，包含開發(fā)，人工、硬件成本等費用。