需求文档规范 _版本号
版权所有 侵权必究
1. 文档历史 修订内容 修订日期 修订版本 修订人 创建 [ 最好在交互之前创建需求文档 ] 哈姆牛特 修订[ 交互/视觉设计稿后需要修订文档 ] 哈姆牛特 修订[ 有需求变动的时候需要修订文档，同时周知 哈姆牛特 文档关系人，将修订的内容明确标识 ] 文档阅读提示 ：勾选视图中的导航窗格，可以让您快速阅读本文档2. 文档目录
3. 项目说明
项目背景和目标 项目背景
[ 背景的描述，主要是当前出现了什么问题？市场上有了什么新的导向？用户有什么样的期待需要我们满足？等 ]
一级 [ 文档结构可以多级，但是不要搞混逻辑层次 ]
二级
三级
四级
项目目标
[ 由背景推导出的目标，简明扼要，目标通常是贯穿整个需求的线索，整个需求都应该是围绕目标在进行的，包括优先级
的排列，也是看需求点能实现目标的程度、效率、紧迫性、成本控制等各方面的综合优势 ]
项目大概
[ 可以分页面、功能模块、流程等进行描述，下面示例， XX产品涉及到 3 个 Tab 对应的页面，所以采用分“页面”的
描述 思路] 举例：
XX产品的三个页面
首页 页面 A 页面 B
页面汇总
[ 将涉及到的页面做个 list ，可以帮助评估设计需求所耗费的时间 ]
举例：
XX 产品涉及的页面 list 文档位置 页面名称 页面数量 所需工作 首页 页面设计 +页面制作 页面 A 3 页面设计 +页面制作 页面 B 页面设计 +页面制作 项目排期
[ 在此可以管理该项目，便于发布项目进度、汇报工作等，在自己本地存储的文档中可以随时补充，如果习惯了其他管理
方式，可以省略 ] 举例：
XX项目进度表
时间 阶段 进度 备注 重构完成 已完成 开发完成 进行中 4. 项目策划
主要逻辑图
[ 按照逻辑线索理出逻辑图，便于阅读者组织对该项目的理解思路，涉及流程的必须给出流程图 ]
功能 / 特性列表（ feature list ）测试重点关注
[ 此处非常重要，详细的功能列表对需求评审、开发时间评估、测试用例撰写等有重要价值，列表可以尽量详细，一个功
能/ 特性点都可以单独一项，基本可以和测试用例对应，同时，需要给出优先级和测试重点 ] 举例：
XX产品功能列表（举例只列出部分）
1，功能列表：简洁概要的描述要实现的功能点，尽可能的细化，具体，可操作，可读性强。直接传递出来要实现的功能 点。不要太模糊和笼统。 2，具体描述 : 给出该功能涉及到的边界值，有效期，概率等等，就是对功能点的属性一个描述。尽量完整，把这个功能 点的各个维度的范围给
出。
3，优先级 :0 最高级，本期必须实现。 1，中级优先，先实现 0 后，再实现。 2，低优先级，本期可以不实现或延后实现。
4. 测试重点：从测试的角度，给出具体描述的各个场景下的一些需要关注的主要测试点。（详细的一些细节可以在正文 里描述，可以写上详见正
文。）这里只需要给出一些方向即可。
是否实现 序 功能列表 号 具体描述 优先级 0>1>2 测试重点 涉及模块 / 页 面 Checklis t 2 在 XX任务中可以做 XX 流程 XXXXXXXX 2 本期未实现 1. XXX 2. XXX XXX 3 交互 / 视觉设计
XXXXXXX 1 已实现 XXX XXX [ 修订文档的时候应该补充好交互 / 视觉设计稿，便于其他阅览者清晰还原需求所在的产品场景，文档描述所见和开发出
的产品所得相统一 ]
需求详细描述
以免费首页部分模块为例，下列给出需求描述的常见案例。 目录：
案例一：需求的描述思路
[ 对需求进行详细描述，仍然可以按照页面、功能模块、流程等组织思路的顺序进行 ]
4.3.1 XX 首页
案例二：按页面模块描述的顺序
[ 按模块进行描述，建议遵守页面布局从上到下，从左到右，从整体到局部，从外至内的顺序，如果是移动端 APP，也
可
以按照由外到内，逐级深入的方式组织描述顺序 ] 举例：
首先首页的描述，首先从头部和侧栏开始
4.3.1.1 头部和侧栏部分
头部入口
案例三：设计图的展示
[ 可以先展示设计图，最好还原该模块在页面中的具体位置，便于其他阅读者查找 ]
举例：
免费首页头部的导航入口截图说明
设计图 局部细节： 全局位置：
案例四：对可操作区的描述
[ 对展示的内容进行描述，如果有可操作部分，需要单独列出：操作前后的状态，操作后的反馈，链接到具体位置等 ]
举例：
对免费首页导航入口的描述
描述：免费整套和免费单品可点击 ， 分别对应免费整套和单品页面，不需要配置
案例五：多采用表格
[ 建议多采用表格的形式把同一个页面 / 模块 / 功能的不同状态、过程等列举出来 ]
举例：
免费首页的个人信息区（含红钻特权推荐） 状态 状态 A 描述 A 描述 B 状态 B 描述 C 状态 C 操作或描述 截图 截图 A 截图 B 截图 A 案例六：涉及数值、等级和状态的描述[ 对不同数值等级，不同的状态，不同的操作反馈，也尽量采用表格形式展示]
举例：
免费首页侧栏部分的“立刻领取”按钮描述
积分 状态 提示 操作反馈 积分 X< 20 分 无 再获得 20-X 积分，您就可以 领取月度礼物了， 查看详情 。 点击“查看详情”后页面刷 新跳转到活跃积分页面。 点击“按钮”后页面刷新跳 转到活未领取满 20 送的礼包 积分 40> X≥ 20 您可以领取月度礼物” +按钮 跃积分页面 再获得 40-X 积分，您就可以 已领取满 20 送的礼包 点击“查看详情”后页面刷 新跳转到活跃积分页面 XXX，查看详情 案例七：线上已有逻辑也需要描述出来
[ 即使是线上逻辑，也尽量把逻辑描述清楚，毕竟你自己应该是最清楚的人 ]
案例八：多内容展示的排序和值域考虑
[ 涉及到多个内容时，一定要考虑排序、值域以及空值和边界等状态 ]
举例：
XX首页 XX 模块
免费送区域
拉取用户好友信息，如图展示，按照生日近远降序排列
[ 涉及到多个内容 / 条目展示的时候，一定要考虑排
序逻辑]
拉取好友数量： [ 也一定要考虑值域和空值状态 ]
最多展示 6 个
如果为 0，则隐藏该区域。 操作体验
点击送更多好友礼物刷新页面跳转至 XX 栏目
点击送礼后 刷新页面跳转 至 XX栏目，并且 带上选定的好友信息 。[ 描述务求准确，清晰 ]
案例九：涉及管理端配置的描述
[ 如果是管理端数据，也需要进行描述，另外，统一归纳到对管理端需求的描述中，需要另起章节 ]
举例：
XXX模块的配置说明
XX免费玩
支持后台管理端配置图片和文字，以及 URL，如图所示
测试需验证“图片和了解详情”的 URL是否和后台管理端配置的统一。
案例十：暂不实现的需求可以文字灰掉
[ 有一些本期不实现了，或者还未确认的，先灰色显示，开发和测试可以直接忽略掉 ]
举例：
XX任务模块暂不实现
XX任务（ 本期暂不实现 ）
从任务管理端拉取任务 ID 配置，此处图片信息等在免费首页管理端配置即可。 领取任务的流程和任务体系保持一致。
5. 统计需求
数据建设：考核评价指标
[ 考核评价指标应该是详细可衡量的，在项目策划的前期就应该考虑到 ]
内容丰富度 访问活跃天 任务、活动完成量
数据统计
[ 根据自身产品的需要，设定页面访问数据，写操作数据、业务数据等多重指标集 ]
点击流统计
统计内容
页面可操作按钮和链接的点击统计 统计目的
方便产品查询用户操作记录数据，分析用户，统计产品使用情况和优化产品的参考等 统计代码 代码格式如下： 一级分 类 登记日期 二级分 类 中文名 称 统计说明截 图 备 需求人 ID 注 2011/10/18 XX XX首页 XX入口 t 哈姆牛 特 代码维护
需要和接口人备案，统一代码命名规则，并上传代码中文名，便于后期数据查看
接口人： XXX 支持后台管理端配置图片和文字，以及
开通钻统计
统计内容
页面开通 / 续费红钻操作按钮的点击统计 统计目的 方便产品查询该按钮的钻开通 / 续费数据 统计代码 参考下表：
URL，如图所示
添加日期 模 块 2011/10/18 详细位置 类型描 述 AID 需求人 XXX 截图 XX.（可以多级）
6. 客服文档 [ 提交开发需求之前即需要准备好客服文档，主要描述产品的目的、背景、用户操作流程、疑问点及对应解决方
案、话术 等]
7. 运营方案
[ 产品运营的同学还需要重视运营方案文档的撰写，包括运营目标、运营规划、具体工作、接口人等 ]
因篇幅问题不能全部显示，请点此查看更多更全内容