为什么要写设计文档
设计文档展现了一个项目的实施方案,可以帮助阅读者更快了解项目的设计思路。
[*] 标为必填项
*设计文档模板
- 团队名称:团队登记表中团队名称
- 作者:列出项目团队所有成员名字
- 项目进展:如有拆分好的 PR 或 issue 可以列出链接
项目介绍
一段简单的介绍即可,帮助文档阅读者了解设计文档的简要信息。
背景&动机
这个设计文件的背景和所要解决的问题是什么?它支持哪些用例?
这部分不需要太多细节,但必须写明项目的动机或背景。写清楚项目的需求从何而来、项目本身解决了什么问题。
项目设计
这一部分可以对设计进行详细的解释;合理清楚地说明该功能将如何实现,通过实例剖析案例,如何使用功能等。
- 应用组:应用本身的架构设计,以及使用 TiDB 的具体功能解决了什么问题
- TiDB 产品组:说明主要想要实现/完善/改进 TiBD 的什么功能,会如何进行实现
这部分可以描述关键算法的伪代码,API 接口,UML 图等,以及还会修改哪些组件。
设计文档讲解视频(可选)
可以录制简单的设计文档讲解视频,辅助评委对项目有更清晰的理解。
RFC 提交方式
提交说明
将 RFC 项目提交到队长的GitHub gist 下,复制 gist 链接,点击链接 ,由队长填写链接完成 RFC 提交(比赛开始后,将不定期从提交 RFC 的团队中抽取几组送出神秘奖品哟)
使用 GitHub gist ,主要是保护 RFC 在初赛前不对外展示哈(仅对外展示项目名称、简介与团队名称),若无法打开 gist,使用队长个人 GitHub 仓库的项目 readme 提交也可以哈。
提交示例
gist 格式模板:https://gist.github.com/Candicepan/87a95e5fc22fc202b74c2fba757b5bac