针对技术需求描述不够具体,制定此规范。
目的:统一开发人员认知,规范代码结构,为代码review和验收提供依据。
模板:
需求描述
- 概要:简要概述需要做一件什么事
- 目的:描述为什么需要做此技术优化,以及优化后达成的预期目标
- 类型:调研任务或者开发任务
- 产出:结果产出的形式,文档或代码
优先级
- 高:解决生产问题、技术瓶颈的需求
- 中:未来产品迭代技术方案调研、核心模块的局部重构
- 低:开发规范、代码优化、新技术尝试等
实现步骤
- 技术选型
- 技术方案:
- 封装与调用关系,开发逻辑流程图
- 代码修改范围列表
- 配置改动范围列表
- 数据库字段改动范围列表
影响范围
- 对于工程模块的影响
- 对于功能测试的影响
问题提醒:根据经验,列出开发者可能会忽视、踩坑的问题列表