搜索

[27480] 2021-02-18_技术需求文档，就该这么写！

文档创建者：s7ckTeam
浏览次数：2
最后更新：2025-01-19
2021-02-18_技术需求文档，就该这么写！ 技 术 需 求 文 档 ， 就 该 这 么 写 ！ 原 创   韦 世 东   N i g h t T e a m   2 0 2 1 - 0 2 - 1 8 " N i g h t T e a m " ， 一 个 值 得 加 星 标 的 公 众 号 。 需 求 文 档 是 我 们 在 开 发 中 常 用 的 一 类 沟 通 方 式 和 媒 介 ， 它 承 载 着 需 求 方 的 期 望 ， 同 时 也 标 记 着 一 系 列 事 项 的 生 命 周 期 。 不 同 部 门 、 不 同 受 众 的 需 求 文 档 各 异 ， 例 如 运 营 人 员 向 产 品 人 员 提 出 的 活 动 需 求 、 产 品 人 员 向 开 发 人 员 提 出 的 功 能 需 求 、 开 发 人 员 向 运 维 人 员 提 出 的 服 务 支 撑 需 求 、 各 小 组 内 部 同 事 之 间 互 相 提 出 的 需 求 等 等 。 为 何 需 要 需 求 文 档 ？ 为 何 需 要 需 求 文 档 ？ 大 部 分 场 景 下 需 求 提 出 方 和 需 求 承 接 方 都 存 在 不 小 的 信 息 差 信 息 差 ， 需 求 提 出 方 常 用 的 语 句 是 “ 我 需 要 做 成 这 样 我 需 要 做 成 这 样 ” 、 “ 越 快 越 好 越 快 越 好 ” 、 “ 怎 怎 么 用 你 不 用 管 ， 给 我 就 行 么 用 你 不 用 管 ， 给 我 就 行 ” 、 “ 这 不 是 我 想 要 的 这 不 是 我 想 要 的 ” 、 “ 我 想 要 的 其 实 是 那 样 我 想 要 的 其 实 是 那 样 ” 。 一 个 人 经 常 否 定 自 己 的 选 择 和 言 语 的 现 象 是 存 在 的 ， 无 论 有 意 或 无 意 ， 但 这 无 疑 会 耗 费 双 方 的 时 间 和 精 力 。 需 求 文 档 不 仅 可 以 作 为 双 方 沟 通 过 程 中 的 清 单 ， 还 可 以 作 为 双 方 选 择 和 执 行 的 日 志 ， 有 了 需 求 文 档 ， 就 能 够 避 免 因 前 后 矛 盾 导 致 空 耗 的 问 题 。 同 时 ， 需 求 文 档 可 以 清 晰 地 体 现 参 与 人 员 的 劳 动 成 果 与 劳 动 价 值 ， 是 自 我 总 结 的 良 好 依 据 。 需 求 文 档 通 用 模 板 参 考 需 求 文 档 通 用 模 板 参 考 一 百 种 需 求 有 一 千 种 提 法 ， 但 需 求 中 的 事 项 相 差 却 无 几 。 这 里 给 出 了 一 份 需 求 文 档 模 板 ， 大 家 可 以 将 其 用 在 工 作 当 中 ， 作 为 不 同 人 员 之 间 的 信 息 传 递 媒 介 。 要 注 意 的 是 ， 需 求 和 执 行 是 双 生 相 伴 的 ， 因 此 这 里 的 下 面 这 份 参 照 文 档 与 其 说 是 需 求 文 档 ， 不 如 说 是 任 务 执 行 记 录 ， 因 为 它 记 录 着 这 个 任 务 从 产 生 到 执 行 完 毕 的 完 整 生 命 周 期 。
为 了 方 便 大 家 理 解 ， 文 档 选 用 不 同 颜 色 来 帮 助 我 们 区 分 阶 段 ， 其 中 ：   浅 粉 色 区 块 呈 现 的 是 文 档 的 基 本 信 息 ；   浅 蓝 色 区 块 呈 现 的 是 需 求 主 体 与 需 求 生 命 周 期 主 体 ；   浅 绿 色 区 块 呈 现 的 是 需 求 生 命 周 期 接 近 末 尾 ， 即 将 达 成 目 的 ； 为 什 么 要 这 么 设 计 ？ 为 什 么 要 这 么 设 计 ？ 相 信 各 位 见 过 不 少 的 需 求 文 档 ， 因 此 对 上 面 这 份 参 考 也 有 不 同 的 看 法 ， 可 能 不 禁 会 问 ： • 为 什 么 设 计 成 这 样 的 结 构 ？
• 怎 么 不 用 在 线 需 求 文 档 管 理 工 具 呢 ？ • 必 填 项 和 非 必 填 项 如 何 体 现 ？ • 这 份 参 考 好 像 不 能 满 足 所 有 开 发 场 景 ？ 为 什 么 设 计 成 这 样 的 结 构 ？ 为 什 么 设 计 成 这 样 的 结 构 ？ 需 求 文 档 应 当 涵 盖 从 需 求 产 生 到 需 求 完 成 交 付 的 完 整 过 程 ， 例 如 需 求 是 在 什 么 样 的 场 景 下 产 生 的 、 到 底 要 做 成 什 么 样 、 需 要 需 求 是 在 什 么 样 的 场 景 下 产 生 的 、 到 底 要 做 成 什 么 样 、 需 要 什 么 时 候 完 成 、 以 什 么 形 式 交 付 、 需 求 是 否 能 够 实 现 、 需 求 实 现 过 程 中 做 了 哪 些 、 交 付 的 结 果 是 否 达 到 预 期 什 么 时 候 完 成 、 以 什 么 形 式 交 付 、 需 求 是 否 能 够 实 现 、 需 求 实 现 过 程 中 做 了 哪 些 、 交 付 的 结 果 是 否 达 到 预 期 等 。 。 我 们 可 以 将 完 整 过 程 分 为 以 下 几 个 阶 段 ， 以 便 更 好 地 展 开 工 作 ：   需 求 描 述   需 求 调 研   需 求 评 审   开 发 / 实 施   阶 段 验 收   测 试 / 数 据 验 证   上 线 按 照 这 个 结 构 ， 我 们 能 够 想 象 工 作 流 大 抵 如 下 ： 首 先 需 求 提 出 方 给 出 需 求 的 背 景 、 具 体 事 项 描 述 等 信 息 ， 帮 助 需 求 承 接 方 更 好 地 理 解 ， 同 时 提 出 对 交 付 时 间 、 交 付 方 式 的 期 望 。 需 求 承 接 方 收 到 需 求 信 息 后 需 要 做 初 步 的 调 研 ， 了 解 需 求 实 现 过 程 中 的 关 键 项 并 记 录 不 明 确 的 事 项 。 接 着 ， 双 方 初 步 接 触 后 约 定 时 间 对 需 求 进 行 评 审 ， 双 方 的 讨 论 将 基 于 调 研 期 间 获 得 的 信 息 展 开 ， 在 评 审 讨 论 会 结 束 后 通 常 会 确 确 定 需 求 是 否 能 实 现 定 需 求 是 否 能 实 现 、 需 求 改 动 项 需 求 改 动 项 、 交 付 方 式 交 付 方 式 、 交 付 时 间 交 付 时 间 、 最 终 参 与 人 员 最 终 参 与 人 员 等 。 然 后 评 审 通 过 ， 需 求 承 接 方 开 始 进 行 开 发 / 实 施 。 需 求 承 接 方 要 记 录 这 个 过 程 中 谁 谁 在 什 么 时 间 什 么 时 间 做 了 什 么 事 什 么 事 并 得 到 怎 样 的 结 果 怎 样 的 结 果 、 期 间 是 否 出 现 了 哪 些 变 化 。 哪 些 变 化 。 需 求 提 出 方 可 能 会 阶 段 性 地 跟 进 事 件 进 展 ， 并 帮 助 需 求 承 接 方 确 认 工 作 和 工 作 结 果 没 有 出 现 偏 差 ， 同 时 双 方 互 换 一 些 信 息 。 开 发 / 实 施 接 近 尾 声 或 完 成 后 ， 需 求 方 组 织 人 员 检 验 成 果 ， 检 验 通 过 则 通 知 需 求 承 接 方 交 付 / 发 布 上 线 ， 检 验 未 通 过 则 做 相 应 调 整 。 版 权 水 印   -   微 信 公 众 号   P y t h o n   编 程 参 考 除 了 需 求 背 景 、 开 发 / 实 施 相 关 的 信 息 外 ， 需 求 文 档 本 身 也 需 要 提 供 一 些 基 础 属 性 ， 用 以 对 需 求 进 行 整 理 、 分 类 、 追 溯 、 总 结 等 ， 所 以 在 需 求 文 档 的 开 头 设 定 了 一 些 重 要 信 息 栏 ， 例 如 ：   需 求 重 要 等 级 ；   需 求 发 起 日 期 ；   需 求 完 结 日 期 ；   需 求 发 起 人 及 对 应 部 门 ；   需 求 承 接 人 及 对 应 部 门 ；   需 求 所 属 的 业 务 类 型 ；   需 求 关 键 词 ；   也 求 所 属 业 务 的 名 称 ；   需 求 关 注 者 ；
  需 求 编 号 ；   需 求 名 称 ； 团 队 内 部 可 以 定 义 统 一 的 需 求 等 级 ， 例 如 紧 急 且 重 要 的 设 为 紧 急 且 重 要 的 设 为   A 、 紧 急 但 不 重 要 的 设 为 紧 急 但 不 重 要 的 设 为   B 1 、 重 要 但 不 紧 急 的 设 为 重 要 但 不 紧 急 的 设 为   B 2 、 不 重 要 不 重 要 也 不 紧 急 的 设 为 也 不 紧 急 的 设 为   C   等 ， 这 样 大 家 在 参 与 需 求 的 时 候 能 够 合 理 地 分 配 时 间 和 资 源 ， 优 先 解 决 那 些 等 级 高 的 需 求 。 怎 么 不 用 在 线 需 求 文 档 管 理 工 具 呢 ？ 怎 么 不 用 在 线 需 求 文 档 管 理 工 具 呢 ？ 市 面 上 的 需 求 文 档 管 理 工 具 繁 多 ， P y t h o n   编 程 参 考 希 望 在 不 依 赖 特 定 工 具 的 情 况 下 向 大 家 介 绍 需 求 文 档 ， 各 位 在 理 解 需 求 文 档 后 再 结 合 工 作 中 用 到 的 管 理 工 具 ， 效 率 定 会 更 高 。 实 际 上 工 作 中 总 是 会 用 到 各 式 各 样 的 管 理 工 具 ， 工 具 可 以 很 好 地 帮 助 我 们 关 联 文 档 、 汇 总 信 息 。 例 如 一 个 编 号 为   T K 2 0 2 0 1 2 0 1 0 1 的 需 求 完 成 后 ， 后 续 又 衍 生 衍 生 出 针 对 它 的 维 护 类 需 求 针 对 它 的 维 护 类 需 求   T K 2 0 2 1 0 1 0 1 0 3   时 ， 可 以 将 维 护 类 需 求   T K 2 0 2 1 0 1 0 1 0 3   与   T K 2 0 2 0 1 2 0 1 0 1 关 联 关 联 起 来 ， 这 样 在 管 理 需 求 文 档 的 时 候 就 能 够 直 观 地 看 到 需 求 之 间 的 关 系 和 变 化 需 求 之 间 的 关 系 和 变 化 ， 具 体 如 下 图 所 示 。 实 际 工 作 中 大 概 率 会 用 到 管 理 工 具 ， 工 具 可 以 提 高 我 们 的 效 率 ， 便 于 我 们 管 理 事 件 ， 借 助 工 具 是 非 常 好 的 选 择 必 填 项 和 非 必 填 项 如 何 体 现 ？ 必 填 项 和 非 必 填 项 如 何 体 现 ？ 实 际 上 这 份 文 档 包 含 的 区 块 都 是 必 要 信 息 ， 但 区 块 中 的 子 项 可 以 根 据 实 际 情 况 省 略 。 首 先 ， 浅 粉 色 区 块 的 需 求 文 档 基 础 信 息 部 分 是 必 填 的 ， 这 里 的 内 容 是 整 个 需 求 的 缩 影 ， 所 以 一 个 格 子 也 不 能 少 。 其 次 ， 浅 蓝 色 区 块 的 主 体 部 分 是 可 以 省 略 的 ， 例 如 有 时 候 需 求 调 研 和 需 求 评 审 可 以 放 在 同 一 时 间 展 开 ， 划 分 到 需 求 评 审 即 可 ； 例 如 子 项 详 细 描 述 中 的 注 意 事 项 注 意 事 项 、 交 付 要 求 交 付 要 求 等 选 项 也 是 可 以 根 据 实 际 情 况 省 略 的 ； 如 果 需 求 并 不 复 杂 ， 或 者 说 时 间 周 期 也 不 长 ， 那 么 子 项 阶 段 验 收 阶 段 验 收 可 以 省 略 ， 在 数 据 验 证 阶 段 校 验 即 可 ； 如 果 没 有 预 上 线 ， 或 者 需 求 并 不 需 要 上 线 ， 那 么 可 以 省 略 浅 绿 色 区 块 部 分 的 项 。
最 后 ， 如 果 觉 得 上 面 的 阶 段 还 不 足 以 记 录 完 整 的 需 求 生 命 周 期 ， 可 以 根 据 实 际 情 况 增 加 阶 段 或 子 项 ； 这 份 参 考 好 像 不 能 满 足 所 有 开 发 场 景 ？ 这 份 参 考 好 像 不 能 满 足 所 有 开 发 场 景 ？ 当 然 ， 开 发 场 景 千 千 万 万 ， P y t h o n   编 程 参 考 提 供 的 这 份 需 求 文 档 作 为 基 础 ， 各 位 在 具 体 使 用 的 时 候 可 以 根 据 团 队 情 况 和 业 务 情 况 自 行 调 整 文 档 项 。 需 求 文 档 实 例 参 考 需 求 文 档 实 例 参 考 虽 然 上 面 提 供 了 一 份 基 础 模 板 ， 但 是 有 一 些 读 者 可 能 还 不 太 明 白 在 实 际 使 用 的 时 候 应 该 如 何 编 写 。 下 面 以 实 际 的 工 作 需 求 给 出 一 份 实 例 参 考 。



阅 读 并 吸 收 上 面 的 知 识 后 ， 想 必 聪 明 的 你 对 整 个 需 求 文 档 的 构 成 、 设 计 考 量 和 具 体 实 践 有 了 一 定 的 认 知 ， 现 在 已 经 能 够 很 好 地 梳 理 、 组 织 需 求 文 档 了 。 这 里 作 者 再 帮 助 诸 位 整 理 一 下 需 求 文 档 的 一 些 细 节 。 需 求 调 研 研 究 的 是 什 么 ？ 需 求 调 研 研 究 的 是 什 么 ？ 需 求 调 研 是 基 于 需 求 展 开 的 实 际 情 况 探 索 ， 主 要 诉 求 是 得 出 是 否 是 否 、 能 否 能 否 等 确 切 的 结 论 ； 例 如 参 考 实 例 中 提 到 的 ：   当 前 线 上   N g i n x   配 置 文 件 是 否 需 要 改 动 ；   调 用 方 是 否 要 在 更 换 新   N g i n x   后 切 换 调 用 地 址 ；   线 上 服 务 地 址 权 限 是 否 能 顺 利 获 得 ； 需 求 评 审 讨 论 什 么 ？ 需 求 评 审 讨 论 什 么 ？ 需 求 评 审 基 于 调 研 结 果 和 需 求 背 景 展 开 ， 主 要 诉 求 是 得 出 实 现 方 式 实 现 方 式 、 结 果 结 果 、 呈 现 方 式 呈 现 方 式 等 确 切 的 结 论 ， 并 针 对 那 些 不 稳 定 的 事 项 给 出 结 果 ， 同 时 也 包 含 是 否 是 否 、 能 否 能 否 等 确 切 结 论 ， 例 如 ：   评 审 项 ： 监 控 项 与 可 视 化 面 板 是 否 匹 配   评 审 结 果 ： 监 控 项 与 可 视 化 面 板 匹 配 ， 但 要 设 定 告 警 则 需 要 单 独 设 置 面 板 ， 不 影 响 展 示 ； 开 发 实 施 记 录 哪 些 内 容 ？ 开 发 实 施 记 录 哪 些 内 容 ？ 开 发 / 实 施 项 中 不 必 记 录 细 节 ， 只 需 要 记 录 阶 段 性 内 容 即 可 。 通 常 是 谁 谁 在 什 么 时 间 什 么 时 间 完 成 了 什 么 事 什 么 事 ， 也 就 是   [ 时 间 时 间 ] [ 人 人 ] [ 事 件 事 件 ]   这 样 的 格 式 ， 例 如 参 考 实 例 中 记 录 的 ：   [ 2 0 2 0 - 1 2 - 0 1 ] [ 数 据 采 集 ] [ 张 三 ]   -   提 供   N g i n x   配 置 文 件 ；   [ 2 0 2 0 - 1 2 - 0 5 ] [ 运 维 ] [ 王 五 ]   -   在   G r a f a n a   中 导 入   P r o m e t h e u s   数 据 源 并 配 置 可 视 化 面 板 ；
  [ 2 0 2 0 - 1 2 - 0 7 ] [ 运 维 ] [ 王 五 ]   -   更 改 域 名 解 析 ； 阶 段 验 收 写 什 么 ？ 阶 段 验 收 写 什 么 ？ 阶 段 验 收 关 注 的 是 事 件 结 果 ， 也 就 是   [ 时 间 时 间 ] [ 人 人 ] [ 结 果 结 果 ]   这 样 的 格 式 ， 与 开 发 / 实 施 记 录 类 似 ， 例 如 参 考 实 例 中 记 录 的 ：   [ 2 0 2 0 - 1 2 - 0 8 ] [ 数 据 采 集 ] [ 张 三 ]   -   服 务 切 换 后 一 切 正 常 ；   [ 2 0 2 0 - 1 2 - 0 6 ] [ 数 据 采 集 ] [ 张 三 ]   -   G r a f n a   可 视 化 面 板 数 据 ；   [ 2 0 2 0 - 1 2 - 0 3 ] [ 数 据 采 集 ] [ 张 三 ]   -   N g i n x   日 志 已 同 步 到   E l a s t i c S e a r c h   中 ； 上 线 项 关 注 什 么 ？ 上 线 项 关 注 什 么 ？ 上 线 项 关 注 的 是 上 线 结 果 和 业 务 本 身 的 状 态 ， 是   [ 时 间 时 间 ] [ 人 人 ] [ 状 态 状 态 ]   这 样 的 格 式 ， 这 样 的 格 式 ， 例 如 参 考 实 例 中 记 录 的 ：   [ 2 0 2 0 - 1 2 - 0 9 ] [ 运 维 ] [ 王 五 ]   -   服 务 正 常 正 常 ；   [ 2 0 2 0 - 1 2 - 0 9 ] [ 数 据 采 集 ] [ 张 三 ]   -   数 据 正 常 ；   [ 2 0 2 0 - 1 2 - 0 9 ] [ 测 试 ] [ 李 四 ]   -   数 据 正 常 ； 这 里 的 状 态 状 态 也 可 以 理 解 为 结 果 结 果 ， 但 细 细 想 来 ， 还 是 用 状 态 更 为 贴 切 一 些 。 这 里 是 微 信 公 众 号   P y t h o n   编 程 参 考 编 程 参 考 ， 如 果 你 觉 得 这 篇 文 章 对 你 有 帮 助 ， 请 来 关 注 我 哦 。 点 击 阅 读 原 文 阅 读 原 文 前 往 作 者 韦 世 东 的 技 术 专 栏   w w w . w e i s h i d o n g . c o m [ 1 ] ， 看 更 多 有 用 知 识 。   热 门 文 章 一 览 热 门 文 章 一 览 w w w . w e i s h i d o n g . c o m :   h t t p s : / / x i e . i n f o q . c n / a r t i c l e / w w w . w e i s h i d o n g . c o m 《 几 个 有 效 应 对   3 5   岁 危 机 的 办 法 》 :   h t t p s : / / w w w . w e i s h i d o n g . c o m / b l o g s / f u n c t i o n a l / s e r v e r / 2 0 2 1 0 1 2 0 0 1 . h t m l 《 工 程 师 绘 图 与 设 计 实 践 指 南 》 :   h t t p s : / / w w w . w e i s h i d o n g . c o m / b l o g s / f u n c t i o n a l / a r c h i t e c t u r a l / d r a w . h t m l 《 持 续 交 付 实 践   -   G i t H u b   A c t i o n s   部 署   N o d e   应 用 到 云 服 务 器 》 :   h t t p s : / / w w w . w e i s h i d o n g . c o m / b l o g s / f u n c t i o n a l / s e r v e r / 2 0 2 0 1 2 2 3 0 2 . h t m l 《 S S H   免 密 码 / 免 用 户 名 / 免 I P 登 录 云 服 务 器 实 践 》 :   h t t p s : / / w w w . w e i s h i d o n g . c o m / b l o g s / f u n c t i o n a l / s e r v e r / 2 0 2 0 1 2 2 3 0 1 . h t m l 《 E l a s t i c S e a r c h   定 时 删 除 指 定 天 数 的 数 据 实 践 》 :   h t t p s : / / w w w . w e i s h i d o n g . c o m / b l o g s / f u n c t i o n a l / s e r v e r / 2 0 2 1 0 1 0 4 0 1 . h t m l
回复

举报

高级模式
B Color Image Link Quote Code Smilies
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

使用Markdown编辑器编辑 使用富文本编辑器编辑

Archiver| 手机版| 小黑屋|
Powered by Discuz! X3.4 Copyright © 2001-2020, Tencent Cloud. 商业源码建议获取授权，如侵犯您的权益，请联系客服处理