文档模板

简介: 文档模板

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

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

[] 背景

[] 目标

[] 解决方案

[] 结论

[] 参考

一、背景

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

二、目标

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

三、解决方案

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

  1. 方案一
  2. 方案二

四、结论

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

五、评审会议及反馈

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

六、参考

  • XXX
  • XXX
目录
相关文章
|
算法 测试技术
详细设计文档格式
1、背景 (背景、原因) 2、名词解释 (对文档中出现新的或不常见的名词、概念或简略语给出定义和解释) 3、设计目标 3.1、实现的功能 (概要描述要实现的功能,列出要实现的功能点及子功能点,并对每一个功能点进行详细说明。
5243 0
|
8月前
|
存储 前端开发 JavaScript
软件设计文档编写指南
软件设计文档编写指南
|
8月前
|
移动开发 小程序 Android开发
基于jeecgboot的flowable为uniapp适配的流程页面调整
基于jeecgboot的flowable为uniapp适配的流程页面调整
172 0
|
存储 Java 关系型数据库
《阿里巴巴Java开发手册》:五、MySQL数据库
《阿里巴巴Java开发手册》:五、MySQL数据库
Win10 如何以管理员身份设置开机自启程序(1)
原文:Win10 如何以管理员身份设置开机自启程序(1) 最近一个项目在win10上部署时遇到问题,即如何设置以管理员身份开机自启。
3251 2
|
测试技术 算法 数据采集
软件开发标准化文档
    在项目开发过程中,应该按要求编写好十三种文档,文档编制要求具有针对性、精确性、清晰性、完整性、灵活性、可追溯性。 ◇可行性分析报告:说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性,评述为了合理地达到开发目标可供选择的各种可能实施方案,说明并论证所选定实施方案的理由。
1372 0
|
7天前
|
弹性计算 人工智能 安全
对话 | ECS如何构筑企业上云的第一道安全防线
随着中小企业加速上云,数据泄露、网络攻击等安全威胁日益严重。阿里云推出深度访谈栏目,汇聚产品技术专家,探讨云上安全问题及应对策略。首期节目聚焦ECS安全性,提出三道防线:数据安全、网络安全和身份认证与权限管理,确保用户在云端的数据主权和业务稳定。此外,阿里云还推出了“ECS 99套餐”,以高性价比提供全面的安全保障,帮助中小企业安全上云。
201858 11
对话 | ECS如何构筑企业上云的第一道安全防线
|
15天前
|
调度 云计算 芯片
云超算技术跃进,阿里云牵头制定我国首个云超算国家标准
近日,由阿里云联合中国电子技术标准化研究院主导制定的首个云超算国家标准已完成报批,不久后将正式批准发布。标准规定了云超算服务涉及的云计算基础资源、资源管理、运行和调度等方面的技术要求,为云超算服务产品的设计、实现、应用和选型提供指导,为云超算在HPC应用和用户的大范围采用奠定了基础。
179632 22
|
3天前
|
弹性计算 人工智能 安全
|
3天前
|
安全 数据安全/隐私保护
阿里云 SASE 2.0 能力迭代|构建一体化办公数据安全解决方案
阿里云SASE能力全新升级,快速构建数据安全治理与运营体系。
1078 3