Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[业务产出]需求文档模板「不断更新」 #16

Open
4 tasks
PeterChen1997 opened this issue Feb 4, 2021 · 0 comments
Open
4 tasks

[业务产出]需求文档模板「不断更新」 #16

PeterChen1997 opened this issue Feb 4, 2021 · 0 comments

Comments

@PeterChen1997
Copy link
Owner

PeterChen1997 commented Feb 4, 2021

技术评审要达到的效果是能够让没做过这个需求的人,看完技术方案,可以很快的明白技术架构,功能流程以及数据库设计

需求背景 Background

需求文档:

PM: @

RD: @谌杨

真实场景

  • (Darwin链接)

影响用户

风险点

思考点

专业名词 Term

  • xxx

方案设计 Proposal

前端相关

系统整体架构

需要实现的功能

功能的UML图

概要设计

  • 核心功能的流程图
  • 是否使用了团队之前未使用到的新技术(发现在很多团队并没有这点的一个说明,这点其实挺重要的,特别是对于一些倒推项目,很容易导致延期)

后端相关

功能说明

数据库设计

接口说明

测试 Case

具体实现 Implementation

额外考虑 AlternativeConsiderations

历史 History

见历史变更

参考资料 References

  • xxx

CR 前确认 Review

代码提交commit

review 前核查

  • 测试 case 完全通过了吗
  • 注释写得怎么样
  • 测试写得怎么样
  • 类型补充完毕没
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant