文档模板

简介: 文档模板

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

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

[] 背景

[] 目标

[] 解决方案

[] 结论

[] 参考

一、背景

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

二、目标

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

三、解决方案

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

  1. 方案一
  2. 方案二

四、结论

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

五、评审会议及反馈

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

六、参考

  • XXX
  • XXX
目录
相关文章
|
关系型数据库 数据库 数据安全/隐私保护
Docker-10:Docker安装PostgreSQL
通过容器化Docker 安装 postgrel
6270 0
Docker-10:Docker安装PostgreSQL
|
存储 安全 测试技术
C# 中模拟HTTPS提交及模拟文件上传
【1月更文挑战第5天】昨天讲到用C#模拟POST还有GET进行数据提交,如果遇到的是https或者一些特殊信道的提交昨天的代码就会跑不通,今天就来说一下C#中https的提交以及模拟文件上传
|
编解码 iOS开发
IOS上架APP Store时预览图尺寸
IOS上架APP Store时预览图尺寸
1981 3
|
数据可视化 Ubuntu 机器人
WebViz可视化工具的应用
【10月更文挑战第2天】WebViz可视化 Webviz是一个基于Web的可视化工具,意味着您可以通过浏览器/APP访问它,而不需要安装额外的软件。这对于远程访问和团队协作非常方便。 Foxglove是一个开源的工具包,包括线上和线下版。旨在简化机器人系统的开发和调试。它提供了一系列用于构建机器人应用程序的功能。 本节将介绍如何使用Foxglove进行数据查看,以及话题通信。 为了实现OriginBot与Foxglove的连接,我们需要在OriginBot上搭建ROS环境。请确保您的机器人是OriginBot(视觉版/导航版),并且您的PC运行的是Ubuntu(≥20.04)或Win
354 1
|
供应链 区块链 数据安全/隐私保护
区块链技术基础:从去中心化到智能合约
区块链技术基础:从去中心化到智能合约
253 0
|
自然语言处理 前端开发
深入解析 React-i18next:在 React 中实现国际化(二)
深入解析 React-i18next:在 React 中实现国际化(二)
404 0
|
人工智能 分布式计算 数据管理
阿里云位居 IDC MarketScape 中国实时湖仓评估领导者类别
国际数据公司( IDC )首次发布了《IDC MarketScape: 中国实时湖仓市场 2024 年厂商评估》,阿里云在首次报告发布即位居领导者类别。
ChatGPT高效提问—prompt基础
ChatGPT高效提问—prompt基础
484 0
|
存储 负载均衡 监控
Linux-虚拟机迁移步骤
虚拟机迁移步骤
540 0
|
自然语言处理 资源调度 前端开发
深入解析 React-i18next:在 React 中实现国际化(一)
深入解析 React-i18next:在 React 中实现国际化(一)
1827 0