XX項目詳細設計說明書-Vx.y2021

機構名稱，2010XX項目詳細設計說明書文件狀態(tài)：[]草稿[√]正式發(fā)布[]正在修改版本：編寫：審核：批準：審批日期：1、狀態(tài)：對于基線庫文檔，應為“1、狀態(tài)：對于基線庫文檔，應為“正式發(fā)布”；2、版本：對于基線庫文檔，指經(jīng)過客戶確認的版本，從1.0開始整數(shù)計數(shù)，2.0,3.0。。。；3、編寫：文檔的主要編寫人員；4、審核：審核包括技術審核、規(guī)范性審核，根據(jù)實際情況，可以填寫多人，如項目經(jīng)理，項目管理中心QA，領導指定人員等；5、批準：各里程碑節(jié)點的批準人：需求文檔：重大項目-業(yè)務總監(jiān)，非重大-部門經(jīng)理設計文檔：重大項目-業(yè)務總監(jiān)、架構師，非重大-部門經(jīng)理測試文檔：重大項目-業(yè)務總監(jiān)，非重大-項目管理中心經(jīng)理里程碑其他文檔（如工作報告，安裝部署、運維手冊、使用手冊等）：重大項目-業(yè)務總監(jiān)，非重大項目-部門經(jīng)理重大項目：軟件開發(fā)項目100萬以上，運維項目200萬以上，氣象服務項目50萬以上華云信息技術工程有限公司XX項目詳細設計說明書華云信息技術工程有限公司 文件更改歷史記錄文件編號：HX-SD-項目英文縮寫-DDD-版本號更改記錄版本號更改要點修改人審批人批準日期1.0正式發(fā)布尹玉梅王桂娟2013.4.2模板編號：HX-SD-IV-DDD版本：1.0DDD:DetailedDesignDocument使用本模板時，請刪除模板更改記錄，填寫項目文檔的版本信息。XX項目詳細設計說明書華云信息技術工程有限公司PAGE6目 錄1引言 11.1編寫目的 11.2背景 11.3基線 11.4范圍 11.5定義 11.6參考資料 22程序系統(tǒng)體系結構 32.1程序劃分 32.2程序層次結構關系 33全局數(shù)據(jù)結構說明 43.1常量 43.2變量 43.3數(shù)據(jù)結構 44程序設計 54.1程序1（標識符）設計說明 54.1.1數(shù)據(jù)結構說明 54.1.2算法及流程 54.1.3數(shù)據(jù)存儲說明 54.1.4源程序文件說明 54.1.5函數(shù)說明 54.2程序2（標識符）設計說明 61附錄：標題一 11.1標題二 11.1.1標題三 12附錄：模板使用說明 22.1文檔模板相關快捷鍵使用說明 22.1.1標題欄 22.1.2正文欄 22.1.3可選欄 22.2整體需要注意的地方 33附錄：圖表編輯要求 43.1圖編輯要求 43.2表編輯要求 54附錄：如何避免標書打印時出問題 64.1避免圖出問題 64.2避免表出問題 6引言【總體說明：1.編寫文檔時，如果某章節(jié)/欄目不適用或不涉及，應注明。并在可能的情況下說明理由。必要時，可增加適當?shù)臈l目。2.本模板中“【…】”內(nèi)容均為填寫說明；在使用時請將其刪除。3.附錄為文檔模板使用說明，包括標題格式、圖表的編輯等都有說明，請編寫文檔時參照。文檔編寫完成后，請將附錄幾個章節(jié)刪除。】編寫目的【說明編寫本軟件詳細設計說明書的目的，指出預期的讀者?！勘尘啊菊f明待開發(fā)軟件系統(tǒng)的名稱?！俊玖谐鲩_發(fā)此軟件系統(tǒng)任務的提出者、開發(fā)者和用戶等。】基線【說明編寫本軟件詳細設計說明書的設計基線?！糠秶菊f明本軟件詳細設計說明書所涉及的內(nèi)容范圍?！慷x【列出本軟件詳細設計說明書中用到的專門術語和縮寫詞原文。】參考資料【屬于本項目的其它已發(fā)表的文件?！俊颈疚募幸玫奈墨I、資料、標準等。】程序系統(tǒng)體系結構程序劃分【用一系列圖表列出本程序系統(tǒng)內(nèi)的每個程序（包括每個模塊和子程序）的名稱、標識符、功能及其所包含的源程序文件名。】程序層次結構關系【用一系列圖表列出本程序系統(tǒng)內(nèi)的每個程序（包括每個模塊和子程序）之間的層次結構與調(diào)用關系?！咳謹?shù)據(jù)結構說明【本章說明本程序系統(tǒng)中使用的全局數(shù)據(jù)常量、變量和數(shù)據(jù)結構。】常量【包括數(shù)據(jù)文件名稱及其所在目錄，功能說明，具體常量說明等?！孔兞俊景〝?shù)據(jù)文件名稱及其所在目錄，功能說明，具體變量說明等。】數(shù)據(jù)結構【包括數(shù)據(jù)結構名稱，功能說明，具體數(shù)據(jù)結構說明（定義、注釋、取值...）等?！砍绦蛟O計【本章逐個地給出各個層次中的每個程序（包括每個模塊和子程序）的設計考慮?！砍绦?（標識符）設計說明數(shù)據(jù)結構說明【給出本程序中的局部數(shù)據(jù)結構說明，包括數(shù)據(jù)結構名稱，功能說明，具體數(shù)據(jù)結構說明（定義、注釋、取值...）等。】算法及流程【給出本程序的算法及流程，可采用流程圖、PAD圖或“表+偽指令”的形式（參照相應的國際標準或國家標準）?！繑?shù)據(jù)存儲說明【具體說明需要以文件方式保存的數(shù)據(jù)文件名、數(shù)據(jù)存儲格式、數(shù)據(jù)項及屬性等?！吭闯绦蛭募f明【給出本程序的各源程序文件的說明，包括源程序文件名稱及其所在目錄，功能說明，包含的前導文件及函數(shù)名稱等?！亢瘮?shù)說明【具體說明本程序中的各個函數(shù)，包括函數(shù)名稱及其所在文件，功能，格式，參數(shù)，全程變量，局部變量，返回值，算法說明，使用約束等?！砍绦?（標識符）設計說明【用類似4.1的方式，說明第2個程序乃至第n個程序的設計考慮。】附錄：標題一標題二標題三標題四標題五標題六附錄：模板使用說明文檔模板相關快捷鍵使用說明標題欄1標題一（快捷鍵ALT+1）1.1標題二（快捷鍵ALT+2）1.1.1標題三（快捷鍵ALT+3）1.1.1.1標題四（快捷鍵ALT+4）1.1.1.1.1標題五（快捷鍵ALT+5）1.1.1.1.1.1標題六（快捷鍵ALT+6）正文欄正文：（快捷鍵ALT+Z），最原始的正文樣式，首行縮進0字。段落：（快捷鍵ALT+D），最原始的段落樣式，首行縮進2字。可選欄如果正文中還需要進行編號按照如下格式：正文內(nèi)編號1（應用Word自帶編號工具，并加粗）再下一級編號1（應用Word自帶編號工具）再下一級編號2正文內(nèi)編號2并列項（應用Word自帶編號工具）再一級并列項（應用Word自帶編號工具）再一級并列項并列項整體需要注意的地方在文檔中請盡量使用已定義好的標準的標題樣式。正文樣式統(tǒng)一用“正文”或“列出段落“樣式（依是否需要首行縮進來選擇）。對于拷貝來的文字，為了避免格式混亂，拷貝到本模板中時需選擇“只保留文本”。（粘貼后在粘貼文字的右下角有一個粘貼選項的浮動圖標，點擊可進入對所粘貼文字設置格式）注意：如果需要插入寬圖或寬表，要設置單獨的節(jié)，將該單獨節(jié)在頁面布局中將紙張方向設置為橫向，并將該節(jié)及下節(jié)頁碼設置為連續(xù)。附錄：圖表編輯要求圖編輯要求示例圖如下圖所示：圖STYLEREF1\s3SEQ圖\*ARABIC\s11XX圖圖編號統(tǒng)一將上面的“圖+圖題注”一起拷貝到文檔中需要貼圖的位置用畫好的新圖替換本圖片修改圖題注中圖的名稱寫分項內(nèi)容的同事不需要再對圖編號進行額外操作總稿人統(tǒng)一對全篇圖題注進行“更新域”操作，使全篇圖編號連續(xù)圖格式參考圖中文字：黑體五號（Visio圖里選10pt），圖中標題性文字可加大一級如小四（Visio圖里選12pt），圖中所有文字字號原則上不超過正文文字字號。圖中文字和連線顏色必須是深色（最好為黑色），否則黑白打印時看不清楚。圖背景可自行配色。表編輯要求示例表如下表所示：表STYLEREF1\s3SEQ表\*ARABIC\s11XX表表頭表頭表頭表頭表頭表頭表內(nèi)文字表內(nèi)文字表內(nèi)文字表內(nèi)文字表內(nèi)文字表內(nèi)文字表內(nèi)文字表內(nèi)文字表內(nèi)文字表內(nèi)文字表內(nèi)文字表內(nèi)文字表內(nèi)文字表內(nèi)文字表內(nèi)文字表內(nèi)文字表內(nèi)文字表內(nèi)文字表編號統(tǒng)一將上面的“表+表題注”一起拷貝到文檔中需要貼圖的位置用編輯好的新表替換本表，或直接在對本表進行編輯修改表題注中表的名稱寫分項內(nèi)容的同事不需要再對表編號進行額外操作總稿人統(tǒng)一對全篇表題注進行“更新域”操作，使全篇表編號連續(xù)表格式參考點擊表格左上角十字架選中整張表格，設置為“居中”將整張表格設置為“五號字”、“單倍行距”表頭：加灰色底紋，文字加粗，單元格對齊方式設置為“水平居中”表內(nèi)：單元格對齊方式設置為“靠上兩端對齊（即左上對齊）”附錄：如何避免標書打印時出問題避免圖出問題在打印前將所有圖轉為圖片格式，否則在打印時