文档模板

简介: 文档模板

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

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

[] 背景

[] 目标

[] 解决方案

[] 结论

[] 参考

一、背景

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

二、目标

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

三、解决方案

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

  1. 方案一
  2. 方案二

四、结论

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

五、评审会议及反馈

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

六、参考

  • XXX
  • XXX
目录
相关文章
需求文档清单思维导图
需求文档清单思维导图
61 0
|
安全 测试技术 开发工具
Git分支和标签的命名规范
四个环境分别是:dev、test、pre、pro(master),中文名字:开发环境、测试环境、灰度环境、生产环境 dev环境:开发环境,外部用户无法访问,开发人员使用,版本变动很大。 test环境:测试环境,外部用户无法访问,专门给测试人员使用的,版本相对稳定 pre环境:灰度环境,外部用户可以访问,但是服务器配置相对低,其它和生产一样。 pro(master)环境:生产环境,面向外部用户的环境,连接上互联网即可访问的正式环境
|
算法 测试技术
详细设计文档格式
1、背景 (背景、原因) 2、名词解释 (对文档中出现新的或不常见的名词、概念或简略语给出定义和解释) 3、设计目标 3.1、实现的功能 (概要描述要实现的功能,列出要实现的功能点及子功能点,并对每一个功能点进行详细说明。
5186 0
|
6月前
|
存储 前端开发 JavaScript
软件设计文档编写指南
软件设计文档编写指南
|
6月前
|
移动开发 小程序 Android开发
基于jeecgboot的flowable为uniapp适配的流程页面调整
基于jeecgboot的flowable为uniapp适配的流程页面调整
156 0
|
数据处理
软件工程——需求分析(生存周期),需求规格说明书,数据流图
在前面我们进行了项目的软件计划,完成了可行性研究报告,知道了要做什么的问题,而下一步,我们就需要进一步的了解项目具体要怎么做,回答必须要做什么的问题了。
|
Java 测试技术 uml
【UML】类图、包图、对象图
【UML】类图、包图、对象图
217 0
|
分布式计算 数据可视化 数据挖掘
06 离线数据分析流程介绍
06 离线数据分析流程介绍
93 0
|
存储 Java 关系型数据库
《阿里巴巴Java开发手册》:五、MySQL数据库
《阿里巴巴Java开发手册》:五、MySQL数据库
|
数据采集 消息中间件 NoSQL
数据预处理-数据清洗需求分析|学习笔记
快速学习数据预处理-数据清洗需求分析
532 0
数据预处理-数据清洗需求分析|学习笔记