【重点】Hackathon RFC 设计文档模板

为什么要写设计文档(RFC)

设计文档展现了一个项目的实施方案,可以帮助阅读者更快了解项目的设计思路。

设计文档模板

  • 作者:列出项目团队所有成员名字

  • 项目进展:如有拆分好的 PR 或 issue 可以列出链接

项目介绍

一段简单的介绍即可,帮助文档阅读者了解设计文档的简要信息。

背景&动机

这个设计文件的背景和所要解决的问题是什么?它支持哪些用例?

这部分不需要太多细节,但必须写明项目的动机或背景。写清楚项目的需求从何而来、项目本身解决了什么问题。

项目设计

这一部分可以对设计进行详细的解释;合理清楚地说明该功能将如何实现,通过实例剖析案例,如何使用功能等。

这部分可以描述关键算法的伪代码,API 接口,UML 图等,以及还会修改哪些组建。

RFC 保存路径

请将 RFC 提交到团队项目 GitHub 仓库的 Readme

RFC 方案提交

确认好内容后,提交到:RFC 立项登记表