黑客松初赛须知|设计文档(RFC)模版

什么是设计文档(RFC)

通过 RFC,我们可以确保所有团队成员对项目的方向和细节有共同的理解,避免误解和重复劳动,提高项目的整体效率。

RFC 文档结构

image

团队成员

列出参与项目的所有团队成员。

项目进度

提供项目当前的进度情况,包括已完成的 PR 或 issue 链接,让进度一目了然。

项目概述

简要介绍项目的核心目标和范围,为大家提供快速了解项目的基本信息。

背景与动机

阐述项目背后的驱动力(如:遇到什么 bug?或需要什么创新 feat)和要解决的问题。这部分需要清晰地说明项目的需求来源,以及将如何满足这些需求,为设计提供坚实的基础。

详细设计

深入展开讲述项目的设计方案,提供系统设计图、代码片段、关键算法说明等。通过具体案例分析,展示功能的实现方式和使用场景。(建议完善主流程的 E2E 测试。)

RFC 如何提交

https://open.oceanbase.com/ai-hackathon

1 个赞