2022年软件开发软件产品开发文件编制指南 .pdf

附录 五国家 标 准计 算 机 软件 产品 开发 文 件 编制 指南国 家 标 准 计 算 机 软 件 产 品 开 发 文 件 编 制 指 南 （ GB 8567 88） 是 一 份指 导 性 文 件 。 它 建 议 在 软 件 的 开 发 过 程 申 编 下 述 14 个 文 件 ： 可 行 性 研 究 报 告 、项 目 开 发 计 划 、 软 件 需 求 说 明 书 、 数 据 要 求 说 明 书 、 总 体 设 计 说 明 书 、 详 细设 计 说 明 、 数 据 库 设 计 说 明 书 、 用 户 手 册 、 操 作 手 册 、 模 块 开 发 卷 、 测 试 计划 、测 试 分 析 报 告 、开 发 进 度 表 、项 目 开 发 总 结 。该 指 南 给 出 了 这 14 个 文 件的 编 制 提 示 ，它 同 时 也 是 这 14 个 文 件 编 写 质 量 的 检 验 准 则 。下 面 详 细 介 绍 这14 种 文 件 的 编 写 目 的 与 内 容 要 求 。l 、 可 行 性 研 究 报 告可 行 性 研 究 报 告 的 目 的 是 ： 说 明 该 软 件 开 发 项 目 的 实 现 在 技 术 上 、 经 济上 和 社 会 条 上 的 可 行 性 ， 论 述 为 了 合 理 地 达 到 开 发 目 标 而 可 能 选 择 的 各 种 方案 ， 说 明 并 论 证 所 选 定 的 方 案 。 可 行 性 研 究 报 告 的 编 写 内 容 见 表 l 。表 l 可 行 性 研 究 报 告1. 引 言编 写 目 的背 景定 义参 考 资 料2. 可 行 性 研 究 的 前 提要 求目 标条 件 、 假 定 和 限 制进 行 可 行 性 研 究 的 方 法评 价 尺 度3. 对 现 有 系 统 的 分 析数 据 流 程 和 处 理 流 程工 作 负 荷消 费 开 支人 员设 备局 限 性4. 所 建 议 的 系 统对 所 建 议 系 统 的 说 明数 据 流 程 和 处 理 流 程改 进 之 处影 响对 设 备 的 影 响对 软 件 的 影 响对 用 户 单 位 机 构 的 影 响对 系 统 运 行 的 影 响对 开 发 的 影 响对 地 点 和 设 施 的 影 响对 经 费 开 支 的 影 响局 限 性技 术 条 件 方 面 的 可 行 性5. 可 选 择 的 其 他 系 统 方 案可 选 择 的 系 统 方 案 1可 选 择 的 系 统 方 案 2 6. 投 资 及 收 益 分 析支 出基 本 建 设 投 资其 他 一 次 性 支 出非 一 次 性 支 出收 益一 次 性 收 益非 一 次 性 收 益不 可 定 量 的 收 益收 益 / 投 资 比投 资 回 收 周 期敏 感 性 分 析7. 社 会 条 件 方 面 的 可 行 性法 律 方 面 的 可 行 性使 用 方 面 的 可 行 性8. 结 论2、 项 目 开 发 计 划编 制 项 目 开 发 计 划 的 目 的 是 用 文 件 的 形 式 ， 并 在 开 发 过 程 中 各 项 工 作 的名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 1 页，共 7 页 - - - - - - - - - 负 责 人 员 、 开 发 进 度 、 经 费 预 算 、 所 需 软 硬 件 条 件 等 问 题 做 出 的 安 排 记 录 下来 ，以 便 根 据 本 计 划 开 展 和 检 查 项 目 的 开 发 工 作 。编 制 内 容 要 求 如 表 2 所 示 。表 2 项 目 开 发 计 划1. 引 言编 写 目 的背 景定 义参 考 资 料2. 项 目 概 述工 作 内 容主 要 参 加 人 员产 品 及 成 果程 序文 件服 务非 移 交 产 品验 收 标 准完 成 项 目 的 最 迟 期 限本 计 划 的 审 批 者 与 批 准 者3. 实 施 总 计 划工 作 任 务 的 分 析接 口 人 员进 度预 算关 键 问 题4. 支 持 条 件计 算 机 统 支 持需 要 用 户 承 担 的 工 作需 由 外 单 位 提 供 的 条 件5. 专 题 计 划 要 点3、 软 件 需 求 说 明 书软 件 需 求 说 明 书 的 编 制 是 为 了 使 用 户 和 软 件 开 发 人 员 双 方 对 该 软 件 的初 始 规 定 有 一 个 共 同 的 理 解 ， 使 之 成 为 整 个 软 件 开 发 工 作 的 基 础 。 其 内 容 要求 见 表 3。表 3 软 件 需 求 说 明 书1. 引 言编 写 目 的背 景定 义参 考 资 料2. 任 务 概 述目 标用 户 的 特 点假 定 的 约 束3. 需 求 规 定对 功 能 的 规 定对 性 能 的 规 定精 度时 间 特 性 要 求灵 活 性输 入 输 出 要 求数 据 管 理 要 求故 障 处 理 要 求其 他 专 门 要 求4. 运 行 环 境 规 定设 备支 撑 软 件接 口控 制4、 数 据 要 求 说 明 书数 据 要 求 说 明 书 的 编 制 目 的 是 为 了 向 整 个 软 件 开 发 时 期 提 供 关 于 被 处理 数 据 的 描 述 和 数 据 采 集 要 求 的 技 术 信 息 ， 其 内 容 要 求 列 于 表 4 中 。表 4 数 据 要 求 说 明 书1. 引 言编 写 目 的背 景定 义参 考 资 料2. 数 据 的 逻 辑 描 述静 态 数 据动 态 输 出 数 据内 部 生 成 数 据数 据 约 定3. 数 据 的 采 集要 求 的 范 围输 入 的 承 担 者处 理名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 2 页，共 7 页 - - - - - - - - - 动 态 输 入 数 据影 响5、 概 要 设 计 说 明 书概 要 设 计 说 明 书 又 称 为 总 体 设 计 说 明 书 ， 编 制 目 的 是 说 明 对 项 目 系 统 的设 计 考 虑 ，包 括 基 本 处 理 流 程 、组 织 结 构 、模 块 结 构 、功 能 配 置 、接 口 设 计 、运 行 设 计 、 系 统 配 置 、 数 据 结 构 设 计 和 出 错 处 理 设 计 等 ， 为 程 序 的 详 细 设 计提 供 基 础 。 其 内 容 要 求 见 表 5。表 5 概 要 设 计 说 明 书1. 引 言编 写 目 的背 景定 义参 考 资 料2. 总 体 设 计运 行 环 境基 本 设 计 概 念 和 处 理 流 程结 构功 能 需 求 与 程 序 的 关 系人 工 处 理 过 程尚 未 解 决 的 问 题3. 接 口 设 计用 户 接 口外 部 接 口内 部 接 口4. 运 行 设 计运 行 模 块 组 合运 行 控 制运 行 时 间5. 系 统 数 据 结 构 设 计逻 辑 结 构 设 计 要 点物 理 结 构 设 计 要 点数 据 结 构 设 计 要 点6. 系 统 出 错 处 理 设 计出 错 信 息补 救 措 施系 统 维 护 设 计6、 详 细 设 计 说 明 书详 细 设 计 说 明 书 又 称 为 程 序 设 计 说 明 ， 编 制 目 的 是 说 明 一 个 软 件 系 统 各个 层 次 中 的 每 一 个 程 序 （ 模 块 ） 的 设 计 考 虑 。 如 果 软 件 系 统 比 较 简 单 ， 层 次少 ， 本 文 件 可 以 不 单 独 编 写 ， 有 关 内 容 可 并 入 概 要 设 计 说 明 书 。 详 细 设 计 说明 书 的 内 容 要 求 见 表 6。表 6 详 细 设 计 说 明 书1. 引 言编 写 目 的背 景定 义参 考 资 料2. 程 序 系 统 的 组 织 结 构3. 程 序 1（ 结 构 符 ） 设 计 说 明程 序 描 述功 能性 能输 入 项输 出 项算 法流 程 逻 辑接 口存 储 分 配注 释 设 计限 制 条 件测 试 设 计尚 未 解 决 的 问 题4. 程 序 2（ 标 识 符 ） 设 计 说 明 书7、 数 据 库 设 计 说 明 书名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 3 页，共 7 页 - - - - - - - - - 数 据 库 设 计 说 明 书 的 编 制 目 的 是 对 于 设 计 中 的 数 据 的 所 有 标 识 、 逻 辑 结表 7 数 据 库 设 计 说 明 书1. 引 言编 写 目 的背 景定 义参 考 资 料2. 外 部 设 计标 识 符 和 状 态使 用 它 的 程 序约 定专 门 指 导支 撑 软 件3. 结 构 设 计概 念 结 构 设 计逻 辑物 理 结 构 设 计4. 运 用 设 计数 据 字 典 设 计安 全 保 密 设 计构 和 物 理 结 构 做 出 具 体 的 设 计 规 定 。 内 容 要 求 见 表 7。8、 用 户 手 册用 户 手 册 的 编 制 是 使 用 非 专 业 术 语 的 语 言 ， 充 分 地 描 述 该 软 件 系 统 所 具有 的 功 能 及 基 本 的 使 用 方 法 。 使 用 户 通 过 本 手 册 能 够 了 解 该 软 件 的 用 途 ， 并能 够 确 定 在 什 么 情 况 下 、 如 何 使 用 它 。 具 体 的 内 容 要 求 见 表 8。表 8 用 户 手 册1. 引 言编 写 目 的背 景定 义参 考 资 料2. 用 途功 能性 能精 度时 间 特 性灵 活 性3. 运 行 环 境硬 环 境支 撑 软 件数 据 结 构4. 使 用 过 程安 全 与 初 始 化输 入输 入 数 据 的 现 实 背 景输 入 格 式输 入 举 例输 出输 出 数 据 的 现 实 背 景输 出 格 式输 出 举 例文 卷 查 询出 错 处 理 与 恢 复终 端 操 作9、 操 作 手 册操 作 手 册 的 编 制 是 为 了 向 操 作 人 员 提 供 该 软 件 每 个 运 行 的 具 体 过 程 的 有关 知 识 ， 包 括 操 作 方 法 的 细 节 。 内 容 要 求 见 表 9。表 9 操 作 手 册1. 引 言编 写 目 的背 景定 义参 考 资 料2. 软 件 概 述软 件 的 结 构运 行 步 骤运 行 1( 标 识 符 ) 说 明运 行 控 制操 作 信 息输 出 文 段输 出 文 段输 出 文 段 的 复 制名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 4 页，共 7 页 - - - - - - - - - 程 序 表文 卷 表3. 安 装 与 初 始 化4. 运 行 说 明运 行 表启 动 恢 复 过 程运 行 2( 标 识 符 ) 说 明 5. 非 常 规 过 程6. 远 程 过 程10 、 模 块 开 发 卷 宗模 块 开 发 卷 宗 是 在 模 块 开 发 过 程 中 逐 步 编 写 出 来 的 。 每 完 成 一 个 模 块 或一 组 密 切 相 关 的 模 块 ， 复 审 时 编 写 出 一 份 ， 应 该 把 所 有 的 模 块 开 发 卷 宗 汇 集在 一 起 。 编 写 的 目 的 是 记 录 和 汇 总 低 层 次 开 发 的 进 度 和 结 果 ； 以 便 于 对 整 个系 统 开 发 工 作 进 行 管 理 的 复 审 ， 并 为 将 来 的 维 护 提 供 有 用 的 技 术 信 息 。 具 体内 容 要 求 见 表 10。11 、 测 试 计 划表 10 模 块 开 发 卷 宗1. 标 题2. 模 块 开 发 情 况 表 ( 见 附 表3. 功 能 说 明4. 设 计 说 明5. 源 代 码 清 单6. 测 试 说 明7. 复 审 的 结 论表 10a 模 块 开 发 情 况 表模 块 标 识 符模 块 的 描 述 性 名 称代 码设 计计 划 开 始 日 期实 际 开 始 日 期计 划 完 成 日 期实 际 完 成 日 期模 块测 试计 划 开 始 日 期实 际 开 始 日 期计 划 完 成 日 期实 际 完 成 日 期组 装测 试计 划 开 始 日 期实 际 开 始 日 期计 划 完 成 日 期实 际 完 成 日 期代 码 复 查 日 期 / 签 字源 代 码 行 数目 标 模 块 大 小项 目 负 责 人 批 准 日 期 / 签 字名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 5 页，共 7 页 - - - - - - - - - 这 里 所 说 的 测 试 是 指 整 个 软 件 系 统 的 组 装 测 试 和 确 认 测 试 ， 本 文 件 的 编制 是 为 了 提 供 一 个 对 该 软 件 的 测 试 计 划 ， 包 括 对 每 项 测 试 活 动 的 内 容 、 进 度安 排 、 设 计 考 虑 、 测 试 数 据 的 整 体 性 方 法 及 评 价 准 则 。 具 体 内 容 见 表 11 。表 11 测 试 计 划1. 引 言编 写 目 的背 景定 义参 考 资 料2. 计 划软 件 说 明测 试 内 容测 试 1( 标 识 符 ) 进 度 安 排条 件测 试 资 料测 试 培 训测 试 2( 标 识 符 ) 3. 测 试 设 计 说 明测 试 1( 标 识 符 ) 控 制输 入输 出过 程测 试 2( 标 识 符 ) 4. 评 价 准 则范 围数 据 整 理尺 度12 、 测 试 分 析 报 告测 试 分 析 报 告 的 编 写 是 为 了 把 组 装 测 试 和 确 认 测 试 的 结 果 、 发 现 的 问 题以 及 分 析 结 果 写 出 成 文 件 形 式 加 以 保 存 ， 具 体 编 写 内 容 要 求 见 表 12 。表 12 测 试 分 析 报 告1. 引 言编 写 目 的背 景定 义参 考 资 料2. 测 试 概 要3. 测 试 结 果 及 发 现测 试 1( 标 识 符 ) 测 试 2( 标 识 符 ) 4. 对 软 件 功 能 的 结 论功 能 1( 标 识 符 ) 能 力限 制功 能 2( 标 识 符 ) 5. 分 析 摘 要能 力缺 陷 和 限 制建 议评 价6. 测 试 资 源 消 耗13 、 开 发 进 度 月 报开 发 进 度 月 报 的 编 制 目 的 是 及 时 向 有 关 管 理 部 汇 报 项 目 开 发 的 进 度 和情 况 , 以 便 及 时 发 现 和 处 理 开 发 过 程 中 出 现 的 问 题 。一 般 来 说 ，开 发 进 度 月 报是 以 项 目 组 为 单 位 每 月 编 写 的 ， 具 体 内 容 要 求 见 表 13 。表 13 开 发 进 度 月 报1. 标 题2. 工 程 进 度 与 状 态进 度态 度3. 资 源 耗 用 与 状 态资 源 耗 用状 态4. 经 费 支 出 与 状 态经 费 支 出支 出 性 费 用设 备 购 置 费状 态名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 6 页，共 7 页 - - - - - - - - - 工 时机 时5. 下 个 月 的 工 作 计 划6. 建 议14 、 项 目 开 发 总 结 报 告项 目 开 发 总 结 报 告 的 编 制 是 为 了 总 结 本 项 目 开 发 工 作 的 经 验 ， 说 明 实 际取 得 的 开 发 成 果 以 及 对 整 个 开 发 工 作 的 各 个 方 面 的 评 价 ， 具 体 内 容 要 求 见 表14。表 14 项 目 开 发 总 结 报 告1. 引 言编 写 目 的背 景定 义参 考 资 料2. 实 际 开 发 结 果产 品主 要 功 能 和 性 能基 本 流 程进 度费 用3. 开 发 工 作 评 价对 生 产 效 率 的 评 价对 产 品 质 量 的 评 价对 技 术 方 法 的 评 价出 错 原 因 的 分 析4. 经 验 与 教 训名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 7 页，共 7 页 - - - - - - - - -