文档模板

简介: 文档模板

对于一些重要的问题或是工作(每个人都能够判断什么是关键问题和工作),需要先把自己的想法share出来,而不是先实现 。Check List评审前自查,评审时复核。在已填写的部分打✔,允许不填但需要文字备注原因。

[] JIRA事务地址 xxx(当JIRA事务进入Reviewing状态时请在JIRA事务描述中添加该飞书文档地址)

[] 背景

[] 目标

[] 解决方案

[] 结论

[] 参考

一、背景

交待这个事的背景,让不熟悉问题背景的同事能够读懂要解决的问题是什么。

二、目标

说明这个事的目标,可以是达成的效果、交付的产物等。例如,服务端交付产物是HTTP API,完成后客户端可以调用这些API达成哪些功能。

三、解决方案

列出多个解决方案,对提出的解决方案进行 Pros/Cons 对比。这些方案需要有权威引用和权威数据支持,不能是拍脑袋想出来的。需要找到这个问题目前在业界 / 公司内最广泛采用的解决方案(即最佳实践)。

  1. 方案一
  2. 方案二

四、结论

结合多方面因素,得出最可行的方案,也可以是作者自己的观点。

五、评审会议及反馈

暂时无法在飞书文档外展示此内容

六、参考

  • XXX
  • XXX
目录
相关文章
|
11月前
|
Ubuntu Linux
ubuntu下使用notepad
ubuntu下使用notepad
464 0
|
存储 NoSQL 算法
图解!24张图彻底弄懂九大常见数据结构!(上)
图解!24张图彻底弄懂九大常见数据结构!
图解!24张图彻底弄懂九大常见数据结构!(上)
|
11月前
|
数据处理
软件工程——需求分析(生存周期),需求规格说明书,数据流图
在前面我们进行了项目的软件计划,完成了可行性研究报告,知道了要做什么的问题,而下一步,我们就需要进一步的了解项目具体要怎么做,回答必须要做什么的问题了。
|
JavaScript 前端开发 API
使用ort.js的create方法加载onnx模型报错:Fetch API cannot load file…… URL scheme “file“ is not supported.
使用ort.js的create方法加载onnx模型报错:Fetch API cannot load file…… URL scheme “file“ is not supported.
490 0
使用ort.js的create方法加载onnx模型报错:Fetch API cannot load file…… URL scheme “file“ is not supported.
|
11月前
|
Java 测试技术 uml
【UML】类图、包图、对象图
【UML】类图、包图、对象图
158 0
|
存储 Java 关系型数据库
《阿里巴巴Java开发手册》:五、MySQL数据库
《阿里巴巴Java开发手册》:五、MySQL数据库
|
11月前
|
Web App开发 Dart 前端开发
flutter开发环境搭建
flutter开发环境搭建
133 0
|
存储 NoSQL MongoDB
MongoDB3.4下载教程
MongoDB3.4下载教程
345 0
|
安全 Oracle 关系型数据库
【IntelliJ IDEA】【SVN】SVN详细的介绍和Idea中如何使用SVN
SVN是Subversion的简称,是一个自由开源的版本控制系统。 Subversion将文件存放在中心版本库里,这个版本库很像一个普通的文件服务器,不同的是,它可以记录每一次文件和目录的修改情况,这样就可以借此将数据恢复到以前的版本,并可以查看数据的更改细节早期版本控制使用的是CVS,后来SVN替代了CVS,随着android兴起,出现Git版本控制工具,后续我们会学到。
673 0
【IntelliJ IDEA】【SVN】SVN详细的介绍和Idea中如何使用SVN
|
数据采集 消息中间件 NoSQL
数据预处理-数据清洗需求分析|学习笔记
快速学习数据预处理-数据清洗需求分析
444 0
数据预处理-数据清洗需求分析|学习笔记