功能规格设计活动流程&规范
版次：2020年11月X日 第1版
文件类型：程序文件
上层文件：软件开发过程要求
上海维宏电子科技股份有限公司 版权所有
| 修改历史 | ||||
|---|---|---|---|---|
| 文件版本 | 修改前文件版本 | 主要修订内容和原因 | 修订人 | 修订日期 |
| R1 | 新建 | 谷艳艳 |
1 目的
明确功能规格设计活动的流程及要求，为活动执行提供指导。
2 适用范围
软件平台及各产品线团队。
3 术语和定义
下列术语和定义适用于本文档。
规则：执行活动时必须遵守的约定。
说明：对活动执行内容进一步补充说明
示例：对规则中描述的内容给出正确的例子。
4 活动流程
4.1 流程图
图1 功能规格设计活动流程图
4.2 流程详解
表 1 功能规格设计活动流程详解
| 活动名称 | 活动描述 | 负责人 | 备注 |
|---|---|---|---|
| 功能规格设计 | 根据需求内容编制或维护已有功能规格书。根据需求内容确定软件功能，查看《产品功能规格表》确定功能对应的规格，以及规格编号。 有规格：对已有的规格进行维护。 无规格：按照功能规格模板编制功能规格。 |
软件开发 | 1. 《产品功能规格表》存放路径详见 “4 附录”。 2. 功能规格模板： 《功能规格模板（GM指令、API）-Rn》、《功能规格模板（带 UI）-Rn》 |
| 功能规格评审 | 对输出的功能规格书由专业团队进行统一评审。 1. 评审内容参考《功能规格审核 Checklist》。 2. 主评审人需要给出评审结论：通过、不通过、有条件通过。 3. 评审后软件开发需输出 DR 实施表，记录评审基本信息以及评审中提出的意见。 4. 评审完成后，软件开发根据评审意见修改文档，并且需将修改方式更新到 DR 实施表中，并与提出意见的评审人员确认，直至评审通过。 5. 评审通过后软件开发需将 DR 实施表中的信息补充完全，并归档至指定位置。 |
产品经理办公室 具体待定 |
归档位置详见 “4 附录”。 |
| 归档 | 更新《产品功能规格表》，将功能规格上传至指定位置：对于新增加的规格编号以及功能名称，需要添加到《产品功能规格表》中，并将功能规格名称与对应规格文档做链接。 | 待定 | 1. 归档位置详见 “4 附录”。 2. 在 Excel 中做功能规格链接时，前半部分链接不变，后面将文件存储位置补充完整即可：http://www.wiki.org:81/#!研发过程记录文件/产品功能规格/（存储位置） |
5 活动执行规范
5.1 功能规格设计
【规则 1-1】新功能开发必须有功能规格设计活动，并输出功能规格书。维护性功能开发，若已有功能规格书，则需同步维护原有功能规格书；若无功能规格书，由总工判断是否需要补充功能规格书。
【规则 1-2】功能规格书中必须注明“规格编号”。
说明：在指定规格编号时，不确定具体编号时，可以“X”代替不确定项，以此避免多团队同时在某一章节增加编号时造成冲突，规格评审通过将功能规格添加到《产品功能规格表》中时再按照已有功能编号顺序添加即可。同时需要更正功能规格书中的规格编号。
示例：例如需要在 6.8 章节增加一个功能，未评审通过时可以先定编号为“6.8.X”；规格评审通过后，将编号更新到《产品规格表》时，6.8 章节只有 6.8.1，则可以定此功能编号为 6.8.2。
【规则 1-3】功能规格书命名规则如下：
<团队名称>-<功能名称>-功能规格-Rn.md
说明：
- <团队名称>：产品线细分行业专用功能使用，通用功能不需要。
- <功能名称>：该功能名称。
- Rn：文档版本号，n 为十进制整数，起始值为 1，只增不减。
示例：通用功能：断点继续-功能规格-R1.md，行业专用功能：激光-随动自动防撞-功能规格-R1.md
【规则 1-4】DR 实施表命名规则如下：
DR 实施表(功能规格)-<团队名称>-<功能名称>-Rn.xls
说明：
- <团队名称>：产品线细分行业专用功能使用，通用功能不需要。
- <功能名称>：评审的功能名称。
- Rn：文档版本号，n 为十进制整数，起始值为 1，只增不减。
示例：通用功能：DR 实施表(功能规格)-断点继续-R1.xls
行业专用功能：DR 实施表(功能规格)- 激光-随动自动防撞-R1.xls
【规则 1-5】功能规格书中若附带有图片，则图片统一存放在名称为 “images” 的文件夹中，将功能规格书和 images 文件夹统一保存在以功能名命名的文件夹中，上传到指定位置；没有附带图片，直接将功能规格书上传到指定位置即可。
示例：
- 刀具寿命管理功能规格书中附带有图片，则在 CNC 文件夹中创建“刀具寿命管理”文件夹，里面包含 “images” 文件夹和“刀具寿命管理- 功能规格-R1.md ”功能规格书。
- 刀具补偿功能规格书中未附带图片，直接将“刀具补偿--功能规格-R1.md”存放在 CNC 文件夹中即可。
5.2 功能规格评审
【规则 2-1】各团队的功能规格统一在“产品功能规格评审会”中进行评审。
【规则 2-2】功能规格书更新一次只输出一份 DR 实施表，用以记录针对本次修改，通过评审发现的所有问题，多次复评的相关信息在同一份表格中更新，直到评审通过。
5.3 归档
【规则 3-1】功能规格书存放需要以 md 格式存放。
【规则 3-2】一份功能规格文档链接在一个主功能中，子功能可不做链接。若文档中涉及的子功能不在同一个主功能下，需要单独链接。
示例：
- 一份规格文档，主要介绍规格编号为 6.8.1 的功能，及其子功能 “6.8.1.1” “6.8.1.2” “6.8.1.3”，则只需要在 6.8.1 上做链接即可。
- 攻牙的功能规格文档中还涉及到 G84 指令，因此需要同时在攻牙功能和 G84 指令上做链接。
6 附录
表2 相关文档存放位置
| 序号 | 文档名称 | 存放位置 |
|---|---|---|
| 1 | 功能规格模板 | http://www.wiki.org:81/#!维宏研发/设计阶段/模板/功能规格模板-R1.md |
| 2 | DR 实施表（功能规格）-<团队名称>-<功能名称>-模板 | http://www.wiki.org:81/#!维宏研发/DesignPhase.md |
| 3 | 功能规格审核 Checklist | http://www.wiki.org:81/#!维宏研发/DesignPhase.md |
| 4 | 产品功能规格表 | Wiki 查看位置：http://www.wiki.org:81/#!维宏研发/设计阶段/产品功能规格/产品功能规格表.md TFS存储位置：tfs.weihong.com:8080/tfs/spi/Process Improvement/mdwiki-SPI/维宏研发/设计阶段/产品功能规格 |
| 5 | 功能规格书 | TFS存储位置： tfs.weihong.com:8080/tfs/spi/Process Improvement/mdwiki-SPI/产品研发/设计阶段/产品功能规格 |
| 6 | DR 实施表 | \file01.weihong.com\01.部门共享\09.软件部\04.记录文件\09.各团队DR实施表 |
编制： 审核： 批准：