計算機軟件開發(fā)文檔編寫規(guī)范

目目 錄錄 封面格式 2 一一 可行性研究報告可行性研究報告 2 二二 項目開發(fā)計劃項目開發(fā)計劃 4 三三 需求規(guī)格說明書需求規(guī)格說明書 5 四四 概要設計說明書概要設計說明書 6 五五 詳細說明書詳細說明書 7 六六 用戶操作手冊用戶操作手冊 8 七七 測試計劃測試計劃 10 八八 測試分析報告測試分析報告 11 九九 開發(fā)進度月報開發(fā)進度月報 12 十十 項目開發(fā)總結(jié)報告項目開發(fā)總結(jié)報告 13 十一十一 程序維護手冊程序維護手冊 13 十二十二 軟件問題報告軟件問題報告 16 十三十三 軟件修改報告軟件修改報告 17 計 算 機 軟 件 開 發(fā) 文 檔 編 寫 規(guī) 范 1 封面格式封面格式 文檔編號 版本號 文檔名稱 項目名稱 項目負責人 編寫 年 月 日 校對 年 月 日 審核 年 月 日 批準 年 月 日 開發(fā)單位 年 月 日 計 算 機 軟 件 開 發(fā) 文 檔 編 寫 規(guī) 范 2 一 可行性研究可行性研究報報告告 1引言引言 1 1 編寫目的 闡明編寫可行性研究報告的目的 指出讀者的對象 1 2 項目背景 應包括 a 所建議開發(fā)軟件的名稱 b 項目的任務提出者 開 發(fā)者 用戶及實現(xiàn)軟件的單位 c 項目與其他軟件或其他系統(tǒng)的關系 1 3 定義 列出文檔中用到的專門術語的定義和縮寫詞的原文 1 4 參考資料 列出有關資料的作者 標題 編號 發(fā)表日期 出版單位或 資料來源 可包括 a 項目經(jīng)核準的計劃任務書 合同或上級機關的批 文 b 與項目有關的已發(fā)表的資料 c 文檔中所引用的資料 所采用的 軟件標準或規(guī)范 2可行性研究的前提可行性研究的前提 2 1 要求 列出并說明建議開發(fā)軟件的基本要求 如 a 功能 b 性能 c 輸 出 d 輸入 e 基本的數(shù)據(jù)流程和處理流程 f 安全與保密要求 g 與 軟件相關的其他系統(tǒng) h 完成期限 2 2 目標 可包括 a 人力與設備費用的節(jié)省 b 處理速度的提高 c 控制精 度或生產(chǎn)能力的提高 d 管理信息服務的改進 e 決策系統(tǒng)的改進 f 人員工作效率的提高 等等 2 3 條件 假定和限制 可包括 a 建議開發(fā)軟件運行的最短壽命 b 進行 系統(tǒng)方案選擇比較的期限 c 經(jīng)費來源和使用限制 d 法律和政策方面 的限制 e 硬件 軟件 運行環(huán)境和開發(fā)環(huán)境的條件和限制 f 可利用 的信息和資源 g 建議開發(fā)軟件投入使用的最遲時間 2 4 可行性研究方法 2 5 決定可行性的主要因素 3對現(xiàn)對現(xiàn)有系有系統(tǒng)統(tǒng)的分析的分析 3 1 處理流程和數(shù)據(jù)流程 3 2 工作負荷 3 3 費用支出 如人力 設備 空間 支持性服務 材料等項開支 3 4 人員 列出所需人員的專業(yè)技術類別和數(shù)量 3 5 設備 3 6 局限性 說明現(xiàn)有系統(tǒng)存在的問題以及為什么需要開發(fā)新的系統(tǒng) 4所建所建議議技技術術可行性分析可行性分析 計 算 機 軟 件 開 發(fā) 文 檔 編 寫 規(guī) 范 3 4 1 對系統(tǒng)的簡要描述 4 2 處理流程和數(shù)據(jù)流程 4 3 與現(xiàn)有系統(tǒng)比較的優(yōu)越性 4 4 采用建議系統(tǒng)可能帶來的影響 4 4 1 對設備的影響 4 4 2 對現(xiàn)有軟件的影響 4 4 3 對用戶的影響 4 4 4 對系統(tǒng)運行的影響 4 4 5 對開發(fā)環(huán)境的影響 4 4 6 對運行環(huán)境的影響 4 4 7 對經(jīng)費支出的影響 4 5 技術可行性評價 包括 a 在限制條件下 功能目標是否能達到 b 利 用現(xiàn)有技術 功能目標能否達到 c 對開發(fā)人員數(shù)量和質(zhì)量的要求 并說明能否滿足 d 在規(guī)定的期限內(nèi) 開發(fā)能否完成 5所建所建議議系系統(tǒng)經(jīng)濟統(tǒng)經(jīng)濟可行性分析可行性分析 5 1 支出 5 1 1基建投資 5 1 2其他一次性支出 5 1 3經(jīng)常性支出 5 2 效益 5 2 1一次性收益 5 2 2經(jīng)常性收益 5 2 3不可定量性收益 5 3 收益 投資比 5 4 投資回收周期 5 5 敏感性分析 敏感性分析是指一些關鍵性因素 如 系統(tǒng)生存周期長 短 系統(tǒng)工作負荷量 處理速度要求 設備和軟件配置變化對支出和 效益的影響等的分析 6社會因素可行性分析社會因素可行性分析 6 1 法律因素 如 合同責任 侵犯專利權(quán) 侵犯版權(quán)等問題的分析 6 2 用戶使用可行性 如 用戶單位的行政管理 工作制度 人員素質(zhì)等能 否滿足要求 7其他可行性其他可行性選擇選擇的方案的方案 計 算 機 軟 件 開 發(fā) 文 檔 編 寫 規(guī) 范 4 逐個闡明其他可供選擇的方案 并重點說明未被推薦的理由 8結(jié)論結(jié)論意意見見 結(jié)論意見可能是 a 可著手組織開發(fā) b 需待若干條件 如資金 人力 設備等 具備后才能開發(fā) c 需對開發(fā)目標進行某些修改 d 不能進行或不必進行 如技 術不成熟 經(jīng)濟上不合算等 e 其他 一 項項目開目開發(fā)計發(fā)計劃劃 1引言引言 1 1 編寫目的 闡明編寫開發(fā)計劃的目的 指出讀者對象 1 2 項目背景 可包括 a 項目的委托單位 開發(fā)單位主管部門 b 該軟件 系統(tǒng)與其他系統(tǒng)的關系 1 3 定義 列出本檔中用到的專門術語的定義和縮寫詞的原文 1 4 參考資料 可包括 a 項目經(jīng)核準的計劃任務書 合同或上級機關的批 文 b 文檔所引用的資料 規(guī)范等 列出這些資料的作者 標題 編號 發(fā)表日期 出版單位或資料來源 2項項目概述目概述 2 1 工作內(nèi)容 簡要說明項目的各項主要工作 介紹所開發(fā)軟件的功能 性能等 若不編寫可行性研究報告 則應在本節(jié)給出較詳細的介紹 2 2 條件與限制 闡明為完成項目應具備的條件 開發(fā)單位已具備的條件 以及尚需創(chuàng)造的條件 必要時還應說明用戶及分合同承包者承擔的 工作 完成期限及其他條件與限制 2 3 產(chǎn)品 2 3 1程序 列出應交付的程序名稱 使用的語言及存儲形式 2 3 2文檔 列出應交付的文檔 2 4 運行環(huán)境 應包括硬件環(huán)境 軟件環(huán)境 2 5 服務 闡明開發(fā)單位可向用戶提供的服務 如人員的培訓 安裝 保修 維護和其他運行支持 2 6 驗收標準 3實實施施計計劃劃 3 1 任務分解 任務的劃分及各項任務的負責人 3 2 進度 按階段完成的項目 用圖表說明開始時間 完成時間 計 算 機 軟 件 開 發(fā) 文 檔 編 寫 規(guī) 范 5 3 3 預算 3 4 關鍵問題 說明可能影響項目的關鍵問題 如設備條件 技術難點或 其他風險因素 4人人員組織員組織及分工及分工 5交付期限交付期限 6專題計專題計劃要點劃要點 如測試計劃 質(zhì)量保證計劃 配置管理計劃 人員培訓計劃 系統(tǒng)安裝計 劃等 一 需求需求規(guī)規(guī)格格說說明明書書 1 引言引言 1 1 編寫目的 闡明編寫需求說明書的目的 指明讀者對象 1 2 項目背景 應包括 a 項目的委托單位 開發(fā)單位和主管部門 b 該軟 件系統(tǒng)與其他系統(tǒng)的關系 1 3 定義 列出文檔中所用到的專門術語的定義和縮寫詞的原文 1 4 參考資料 可包括 a 項目經(jīng)核準的計劃任務書 合同或上級機關的批 文 b 項目開發(fā)計劃 c 文檔所引用的資料 標準和規(guī)范 列出這些資 料的作者 標題 編號 發(fā)表日出版單位或資料來源 2任任務務來源來源 2 1 目標 2 2 運行環(huán)境 2 3 條件與限制 3數(shù)據(jù)描述數(shù)據(jù)描述 3 1 靜態(tài)數(shù)據(jù) 3 2 動態(tài)數(shù)據(jù) 包括輸入數(shù)據(jù)和輸出數(shù)據(jù) 3 3 數(shù)據(jù)庫描述 給出使用數(shù)據(jù)庫的名稱和類型 3 4 數(shù)據(jù)詞典 3 5 數(shù)據(jù)采集 4功能需求功能需求 4 1 功能劃分 4 2 功能描述 計 算 機 軟 件 開 發(fā) 文 檔 編 寫 規(guī) 范 6 5性能需求性能需求 5 1 數(shù)據(jù)精確度 5 2 時間特性 如響應時間 更新處理時間 數(shù)據(jù)轉(zhuǎn)換與傳輸時運行時間 等 5 3 適應性 在操作方式 運行環(huán)境 與其他軟件的接口以及開發(fā)計劃等 發(fā)生變化時 應具有的適應能力 6運行需求運行需求 6 1 用戶界面 如屏幕格式 報表格式 菜單格式 輸入輸出時間等 6 2 硬件接口 6 3 軟件接口 6 4 故障處理 7其他需求其他需求 如可使用性 安全保密 可維護性 可移植性等 一 概要概要設計說設計說明明書書 1引言引言 1 1 編寫的目的 闡明編寫概要設計說明書的目的 指明讀者對象 1 2 項目背景 應包括 a 項目的委托單位 開發(fā)單位和主管部門 b 該軟 件系統(tǒng)與其他系統(tǒng)的關系 1 3 定義 列出本文檔中所用到的專門術語的定義和縮寫詞的原意 1 4 參考資料 列出有關資料的作者 標題 編號 發(fā)表日期 出版單位或 資料來源 可包括 a 項目經(jīng)核準的計劃任務書 合同或上級機關的 批文 b 項目開發(fā)計劃 c 需求規(guī)格說明書 d 測試計劃 初稿 e 用戶 操作手冊 初稿 f 文檔所用的資料 采用的標準或規(guī)范 2任任務務概述概述 2 1 目標 2 2 運行環(huán)境 2 3 需求概述 2 4 條件與限制 3總總體體設計設計 3 1 處理流程 計 算 機 軟 件 開 發(fā) 文 檔 編 寫 規(guī) 范 7 3 2 總體結(jié)構(gòu)和模塊外部設計 3 3 功能分配 表明各項功能與程序結(jié)構(gòu)的關系 4接口接口設計設計 4 1 外部接口 包括用戶界面 軟件接口與硬件接口 4 2 內(nèi)部接口 模塊之間的接口 5數(shù)據(jù)數(shù)據(jù)結(jié)結(jié)構(gòu)構(gòu)設計設計 5 1 邏輯結(jié)構(gòu)設計 5 2 物理結(jié)構(gòu)設計 5 3 數(shù)據(jù)結(jié)構(gòu)與程序的關系 6運行運行設計設計 6 1 運行模塊的組合 6 2 運行控制 6 3 運行時間 7出出錯處錯處理理設計設計 7 1 出錯輸出信息 7 2 出錯處理對策 如設置后備 性能降級 恢復及再啟動等 8安全保密安全保密設計設計 9維護設計維護設計 說明為方便維護工作的設施 如維護模塊等 一 詳細說詳細說明明書書 1引言引言 1 1 編寫目的 闡明編寫詳細設計說明書的目的 指明讀者對象 1 2 項目背景 應包括項目的來源和主管部門等 1 3 定義 列出文檔中所用到的專門術語的定義各縮寫詞的原意 1 4 參考資料 列出有關資料的作者 標題 編號 發(fā)表日期 出版單位或 資料來源 可包括 a 項目的計劃任務書 合同或批文 b 項目開發(fā)計 劃 c 需求規(guī)格說明書 d 概要設計說明書 e 測試計劃 初稿 f 用戶 操作手冊 初稿 g 文檔所引用的其他資料 軟件開發(fā)標準或規(guī)范 2總總體體設計設計 2 1 需求概述 計 算 機 軟 件 開 發(fā) 文 檔 編 寫 規(guī) 范 8 2 2 軟件結(jié)構(gòu) 如給出的軟件系統(tǒng)的結(jié)構(gòu)圖 3程序描述程序描述 逐個模塊給出以下的說明 3 1 功能 3 2 性能 3 3 輸入項目 3 4 輸出項目 3 5 算法 模塊所選用的算法 3 6 程序邏輯 詳細描述模塊實現(xiàn)的算法 可采用 a 標準流程圖 b PDL 語言 c N S 圖 d PAD e 判定表等描述算法的圖表 3 7 接口 3 8 存儲分配 3 9 限制條件 3 10 測試要點 給出測試模塊的主要測試要求 一 用用戶戶操作手冊操作手冊 1引言引言 1 1 編寫目的 闡明編寫手冊的目的 指明讀者對象 1 2 項目背景 說明項目來源 委托單位 開發(fā)單位及主管部門 1 3 定義 列出手冊中使用的專門術語的定義和縮寫詞的原意 1 4 參考資料 列出有關資料的作者 標題 編號 發(fā)表日期 出版單位或 資料來源 可包括 a 項目的計劃任務書 合同或批文 b 項目開發(fā)計 劃 c 需求規(guī)格說明書 d 概要設計說明書 e 詳細設計說明書 f 測試 計劃 g 手冊中引用的其他資料 采用的軟件工程標準或軟件工程規(guī) 范 2軟軟件概述件概述 2 1 目標 2 2 功能 2 3 性能 2 3 1數(shù)據(jù)精確度 包括輸入 輸出及處理數(shù)據(jù)的精度 2 3 2時間特性 如響應時間 數(shù)據(jù)傳輸時間等 計 算 機 軟 件 開 發(fā) 文 檔 編 寫 規(guī) 范 9 2 3 3靈活性 在操作方式 運行環(huán)境需做某些變更時軟件的適應能力 3運行情況運行情況 3 1 硬件 列出軟件系統(tǒng)運行所需的硬件最小配置 如 a 計算機型號 主 存容量 b 外存儲器 媒體 記錄格式 設備型號及數(shù)量 c 輸入 輸出 設備 d 數(shù)據(jù)傳輸設備及數(shù)據(jù)轉(zhuǎn)換設備的型號及數(shù)量 3 2 支持軟件 如 a 操作系統(tǒng)名稱及版本號 b 語言編譯系統(tǒng)或匯編系統(tǒng) 的名稱及版本號 c 數(shù)據(jù)庫管理系統(tǒng)的名稱及版本號 d 其他必要的支 持軟件 4使用使用說說明明 4 1 安裝和初始化 給出程序的存儲形式 操作命令 反饋信息及其含意 表明安裝完成的測試實例以及安裝所需用軟件工具等 4 2 輸入 給出輸入數(shù)據(jù)或參數(shù)的要求 4 2 1數(shù)據(jù)背景 說明數(shù)據(jù)來源 存儲媒體 出現(xiàn)頻度 限制和質(zhì)量管理 等 4 2 2數(shù)據(jù)格式 如 a 長度 b 格式基準 c 標號 d 順序 e 分隔符 f 詞匯 表 g 省略和重復 h 控制 4 2 3輸入舉例 4 3 輸出 給出每項輸出數(shù)據(jù)的說明 4 3 1數(shù)據(jù)背景 說明輸出數(shù)據(jù)的去向 使用頻度 存放媒體及質(zhì)量管 理等 4 3 2數(shù)據(jù)格式 詳細闡明每一輸出數(shù)據(jù)的格式 如 首部 主體和尾部 的具體形式 4 3 3舉例 4 4 出錯和恢復 給出 a 出錯信息及其含意 b 用戶應采取的措施 如修 改 恢復 再啟動 4 5 求助查詢 說明如何操作 5運行運行說說明明 5 1 運行表 列出每種可能的運行情況 說明其運行目的 5 2 運行步驟 按順序說明每種運行的步驟 應包括 5 2 1運行控制 5 2 2操作信息 a 運行目的 b 操作要求 c 啟動方法 d 預計運行時間 e 操作命令 計 算 機 軟 件 開 發(fā) 文 檔 編 寫 規(guī) 范 10 格式及說明 f 其他事項 5 2 3輸入 輸出文件 給出建立或更新文件的有關信息 如 a 文件的名稱及編號 b 記錄媒體 c 存留的目錄 d 文件的支配 說明確定保留文件或廢棄文件的準則 分發(fā)文件的對象 占用 硬件的優(yōu)先級及保密控制等 5 2 4啟動或恢復過程 6非常非常規(guī)過規(guī)過程程 提供應急或非常規(guī)操作的必要信息及操作步驟 如出錯處理操作 向后 備系統(tǒng)切換操作以及維護人員須知的操作和注意事項 7操作命令一操作命令一覽覽表表 按字母順序逐個列出全部操作命令的格式 功能及參數(shù)說明 8程序文件 或命令文件 和數(shù)據(jù)文件一程序文件 或命令文件 和數(shù)據(jù)文件一覽覽表表 按文件名字母順序或按功能與模塊分類順序逐個列出文件名稱 標識符 及說明 9用用戶戶操作操作舉舉例例 一 測試計測試計劃劃 1引言引言 1 1 編寫目的 闡明編寫測試計劃的目的并指明讀者對象 1 2 項目背景 說明項目的來源 委托單位及主管部門 1 3 定義 列出測試計劃中所用到的專門術語的定義和縮寫詞的原意 1 4 參考資料 列出有關資料的作者 標題 編號恨表日期 出版單位或資 料來源 可包括 a 項目的計劃任務書 合同或批文 b 項目開發(fā)計劃 c 需求規(guī)格說明書 d 概要設計說明書 e 詳細設計說書 f 用戶操作手 冊 g 本測試計劃中引用的其他資料 采用的軟件開發(fā)標準或規(guī)范 2任任務務概述概述 2 1 目標 2 2 運行環(huán)境 2 3 需求概述 2 4 條件與限制 3計計劃劃 計 算 機 軟 件 開 發(fā) 文 檔 編 寫 規(guī) 范 11 3 1 測試方案 說明確定測試方法和選取測試用例的原則 3 2 測試項目 列出組裝測試和確認測試中每一項測試的內(nèi)容 名稱 目 的和進度 3 3 測試準備 3 4 測試機構(gòu)及人員 測試機構(gòu)名稱 負責人和職責 4測試項測試項目目說說明明 按順序逐個對測試項目做出說明 4 1 測試項目名稱及測試內(nèi)容 4 2 測試用例 4 2 1輸入 輸入的數(shù)據(jù)和輸入的命令 4 2 2輸出 預期的輸出數(shù)據(jù) 4 2 3步驟及操作 4 2 4允許偏差 給出實測結(jié)果與預期結(jié)果之間允許偏差范圍 4 3 進度 4 4 條件 給出項測試對資源的特殊要求 如設備 軟件 人員等 4 5 測試資料 說明項測試所需的資料 5評評價價 5 1 范圍 說明所完成的各項測試說明問題的范圍及其局限性 5 2 準則 說明評價測試結(jié)果的準則 一 測試測試分析分析報報告告 1引言引言 1 1 編寫目的 闡明編寫測試計劃的目的并指明讀者對象 1 2 項目背景 說明項目的來源 委托單位及主管部門 1 3 定義 列出測試報告中用到的專門術語的定義和縮寫詞的原意 1 4 參考資料 列出有關資料的作者 標題 編號 發(fā)表日期 出版單位或 資料來源 可包括 a 項目的計劃任務書 合同或批文 b 項目開發(fā)計 劃 c 需求規(guī)格說明書 d 概要設計說明書 e 詳細設計說明書 f 用戶 操作手冊 g 測試計劃 h 測試分析報告所引用的其他資料 采用的軟 件工程標準或軟件工程規(guī)范 2測試計測試計劃劃執(zhí)執(zhí)行情況行情況 計 算 機 軟 件 開 發(fā) 文 檔 編 寫 規(guī) 范 12 2 1 測試項目 列出每一次測試項目的名稱 內(nèi)容和目的 2 2 測試機構(gòu)和人員 給出測試機構(gòu)名稱 負責人和參與測試人員名單 2 3 測試結(jié)果 按順序給出每一測試項目的 a 實測結(jié)果數(shù)據(jù) b 與預期結(jié) 果數(shù)據(jù)的偏差 c 該項測試表明的事實 d 該項測試發(fā)現(xiàn)的問題 3軟軟件需求件需求測試結(jié)論測試結(jié)論 按順序給出每一項需求測試的結(jié)論 包括 a 證實的軟件能力 b 局限性 即項 需求未得到充分測試的情況及原因 4評評價價 4 1軟件能力 經(jīng)過測試所表明的軟件能力 4 2缺陷和限制 說明測試所揭露的軟件缺陷和不足 以及可能給軟件運 行帶來的影響 4 3建議 提出為彌補上述缺陷的建議 4 4測試結(jié)論 說明能否通過 一 開開發(fā)進發(fā)進度月度月報報 1報報告告時間時間及所及所處處的開的開發(fā)階發(fā)階段段 2工程工程進進度度 2 1本月內(nèi)的主要活動 2 2實際進展與計劃比較 3所用工所用工時時 按不同層次人員分別計時 4所用機所用機時時 按所用計算機機型分別計時 5經(jīng)費經(jīng)費支出支出 分類列出本月經(jīng)費支出項目 給出支出總額 并與計劃比較 6工作遇到的工作遇到的問題問題及采取的及采取的對對策策 7本月完成的成果本月完成的成果 8下月的工作下月的工作計計劃劃 9特殊特殊問題問題 計 算 機 軟 件 開 發(fā) 文 檔 編 寫 規(guī) 范 13 一 項項目開目開發(fā)總結(jié)報發(fā)總結(jié)報告告 1引言引言 1 1 編寫目的 闡明編寫總結(jié)計劃的目的并指明讀者對象 1 2 項目背景 說明項目的來源 委托單位開發(fā)單位及主管部門 1 3 定義 列出報告用到的專門術語的定義和縮寫詞的原意 1 4 參考資料 列出有關資料的作者 標題 編號 發(fā)表日期 出版單位或 資料來源 可包括 a 項目經(jīng)核準的計劃任務書 合同或上級機關的 批文 b 項目開發(fā)計劃 c 需求規(guī)格說明書 d 概要設計說明書 e 詳細 設計說明書 f 用戶操作手冊 g 測試計劃 h 測試分析報告 I 本報告 引用的其他資料 采用的開發(fā)標準或開發(fā)規(guī)范 2開開發(fā)結(jié)發(fā)結(jié)果果 2 1 產(chǎn)品 可包括 a 列出各部分和程序名稱 源程序行數(shù) 包括注釋行 或 目標程序字節(jié)數(shù)及程序字節(jié)數(shù)及程序總計數(shù)量 存儲形式 b 產(chǎn)品文 檔名稱等 2 2 主要功能及性能 2 3 所用工時 按人員的不同層次分別計時 2 4 所用機時 按所用計算機機型分別計時 2 5 進度 給出計劃進度與實際進度的對比 2 6 費用 3評評價價 3 1 生產(chǎn)率評價 如平均每人每月生產(chǎn)的源程序行數(shù) 文檔的字數(shù)等 3 2 技術方案評價 3 3 產(chǎn)品質(zhì)量評價 4經(jīng)驗經(jīng)驗與教與教訓訓 一一 程序程序維護維護手冊手冊 1引言引言 1 1 編寫目的 闡明編寫手冊的目的并指明讀者對象 1 2 開發(fā)單位 說明項目的提出者 開發(fā)者 用戶和使用場所 1 3 定義 列出報告用到的專門術語的定義和縮寫詞的原意 1 4 參考資料 列出有關資料的作者 標題 編號 發(fā)表日期 出版單位或 計 算 機 軟 件 開 發(fā) 文 檔 編 寫 規(guī) 范 14 資料來源以及保密級別 可包括 a 用戶操作手冊 b 與本項目有關 節(jié)其他文檔 2系系統(tǒng)說統(tǒng)說明明 2 1 系統(tǒng)用途 說明系統(tǒng)具備的功能 輸入和輸出 2 2 安全保密 說明系統(tǒng)安全保密方面的考慮 2 3 總體說明 說明系統(tǒng)的總體功能 對系統(tǒng) 子系統(tǒng)和作業(yè)做出綜合性 的介紹 并用圖表的方式給出系統(tǒng)主要部分的內(nèi)部關系 2 4 程序說明 說明系統(tǒng)中每一程序 分程序的細節(jié)和特性 2 4 1程序說明功能 2 4 1 1 功能 說明程序的功能 2 4 1 2 方法 說明實現(xiàn)方法 2 4 1 3 輸入 說明程序的輸入 媒體 運行數(shù)據(jù)記錄 運行開始 時使用的輸入數(shù)據(jù)的類型和存放單元 與程序初始化有關 的入口要求 2 4 1 4 處理 處理特點的目的 如 a 用圖一說明程序的運行和 邏輯流程 b 程序主要轉(zhuǎn)移條件 c 對程序的約束條件 d 程 序結(jié)束時的出口要求 e 與下一程序的通信與聯(lián)結(jié) 運行 控制 f 由該程序產(chǎn)生并供處理程序段使用的輸出數(shù)據(jù)類 型和存放單元 g 程序運行所用存儲量 類型及存儲位置等 2 4 1 5 輸出 程序的輸出 2 4 1 6 接口 本程序與本系統(tǒng)其他部分的接口 2 4 1 7 表格 說明內(nèi)部的各種表 項的細節(jié)和特性 對每張表的 說明至少包括 a 表的標識符 b 使用目的 c 使用此表的其 他程序 d 邏輯劃分 如塊或部 不包括表項 e 表的基本結(jié) 構(gòu) f 設計安排 包括表的控制信息 表目結(jié)構(gòu)細節(jié) 使用中 的特有性質(zhì)及各表項的標識 位置 用途 類型 編碼表示 2 4 1 8 特有的運行性質(zhì) 說明在用戶操作手冊中沒有提到的運 行性質(zhì) 2 4 2程序 2 的說明 與程序 1 的說明相同 以后其他各程序的說明相 同 3操作操作環(huán)環(huán)境境 計 算 機 軟 件 開 發(fā) 文 檔 編 寫 規(guī) 范 15 3 1 設備 逐項說明系統(tǒng)的設備配置及其特性 3 2 支持軟件 列出系統(tǒng)使用的運行軟件 包括它們的名稱和版本號 3 3 數(shù)據(jù)庫 說明每個數(shù)據(jù)庫的性質(zhì)和內(nèi)容 包括安全考慮 3 3 1總體特征 如 a 標識符 b 使用這些數(shù)據(jù)庫的程序 c 靜態(tài)數(shù)據(jù) d 動態(tài)數(shù)據(jù) e 數(shù)據(jù)庫的存儲媒體 f 程序使用數(shù)據(jù)庫的限制 3 3 2結(jié)構(gòu)及詳細說明 3 3 2 1 說明該數(shù)據(jù)庫的結(jié)構(gòu) 包括其中的記錄和項 3 3 2 2 說明記錄的組成 包括首部或控制段 記錄體 3 3 2 3 說明每個記錄結(jié)構(gòu)的字段 包括 標記或標號 字段的字 符長度和位數(shù) 該字段的允許值范圍 3 3 2 4 擴充 說明為記錄結(jié)構(gòu)的字段 4維護過維護過程程 4 1 約定 列出該軟件系統(tǒng)設計中所使用全部規(guī)則和約定 包括 a 程序 分程序 記錄 字段和存儲區(qū)的標識或標號助記符的使用規(guī)則 b 圖表的處理標準 卡片的連接順序 語句和記號中使用的縮寫 出現(xiàn)在圖表中的符號 c 使用 軟件技術標準 d 標準化數(shù)據(jù)元素及其特征 4 2 驗證過程 說明一個程序段修改后 對其進行驗證的要求和過程 包括測試程序和 數(shù)據(jù) 及程序周期性驗證的過程 4 3 出錯及糾正方法 列出出錯狀態(tài)及其糾正方法 4 4 專門維護過程 說明文檔其他地方?jīng)]有提到的專門維護過程 如 a 維護該軟件系統(tǒng)的輸 入輸出部分 如數(shù)據(jù)庫 的要求 過程和驗證方法 b 運行程序庫維護系統(tǒng) 所必需的要求 過程和驗證方法 c 以閏年 世紀變更所需要的臨時性修改 等 4 5 專用維護程序 列出維護軟件系統(tǒng)使用的后備技術和專用程序 如文件恢復程序 淘汰 過時文件的程序等 的目錄 并加以說明 內(nèi)容包括 a 維護作業(yè)的輸入輸 計 算 機 軟 件 開 發(fā) 文 檔 編 寫 規(guī) 范 16 出要求 b 輸入的詳細過程及在硬設備上建立 運行并完成維護作業(yè)操作 步驟 4 6 程序清單和流程圖 引用資料或提供附錄給出程序清單和流程圖 一一 軟軟件件問題報問題報告告 1登登記記號號 由軟件配置管理部門為該報告規(guī)定一個唯一的 順序的編號 2登登記記日期日期 軟件配置管理部門登記該報告的日期 3問題發(fā)現(xiàn)問題發(fā)現(xiàn)日期日期 發(fā)現(xiàn)該問題的日期和時間 4活活動動 在哪個階段發(fā)現(xiàn)的問題 分為單元測試 組裝測試 確認測試和運行維護 5狀狀態(tài)態(tài) 在軟件與配置記錄中維護的動態(tài)指示 狀態(tài)表示有 a 正在復查 軟件問題報 告 以確定將采取什么行動 b 軟件問題報告 已由指定的人進行處理 c 修改 已完成 并經(jīng)過測試 正準備交給主程序庫 d 主程序已經(jīng)更新 主程庫修改的 重新測試尚未完成 e 做了重新測試 問題再現(xiàn) f 做了重新測試 所做的修改 無故障 軟件問題報告 被關閉 g 留待以后關閉 6報報告人告人 填寫 軟件問題報告 人員的姓名 地址 電話 7問題問題屬于什么方面屬于什么方面 區(qū)分是程序的問題 還是模塊的問題 或是數(shù)據(jù)庫的問題 文件的問題 也可 以能是它們的某種組合 8模模塊塊 子系子系統(tǒng)統(tǒng) 出現(xiàn)的模塊名 如果不知是哪個模塊 可標出子系統(tǒng)名 盡量給出細節(jié) 9修修訂訂版本號版本號 出現(xiàn)問題的模塊版本 10 磁磁帶帶 包含