这是一个面向个人项目的文档驱动开发模板。它把项目背景、业务规则、数据库迁移、测试用例和开源基础设施约定放在仓库中,让 Codex、Cursor 等 AI 工具可以先读规范再实现代码。
- 复制模板到新项目,修改根目录
CONTEXT.md,补充项目名称、业务背景和特殊技术要求。 - 在
docs/rules/写不可随意修改的算法、状态机、阈值和业务约束。 - 在
docs/database/migrations/添加 PostgreSQL/Flyway 数据库迁移脚本。 - 把 PRD、TRD、接口约定和 UI 流程放到
docs/对应目录。 - 在
test/test-cases.md选择通用用例,并补充项目自己的验收用例。 - 需要组件写法时参考
docs/examples/,不要复制项目无关的业务代码。
让 AI 开始开发时,使用类似下面的指令:
先读
CONTEXT.md和所有docs/文档,理解需求、规则和数据库迁移,再实现第一个小功能;先写测试并确认测试会失败,完成后运行相关测试。
your-project/
├── CONTEXT.md # 项目总规则
├── README.md # 项目说明
├── docs/
│ ├── database/migrations/ # Flyway 迁移脚本
│ ├── rules/ # 核心业务规则
│ ├── examples/ # 开源组件示例
│ └── ui-flow/ # UI 流程和设计稿
├── backend/ # Spring Boot 后端(按项目需要命名)
├── frontend/ # React 前端
├── deploy/ # Docker Compose 和部署配置
└── test/ # 测试用例和模板验证
Spring Boot + MyBatis-Plus
PostgreSQL 16 + pgvector
Redis 7 + Redisson
Spring Boot 外部化配置(可选 Nacos 2.x)
MinIO/RustFS(可选)
本地依赖可以通过 deploy/compose.yaml 启动。生产环境只通过环境变量或密钥管理系统注入密码和 Token,禁止提交 .env。
- 小步实现,每次只完成一个可验证的行为。
- 核心规则先改文档,再改代码和测试。
- 默认优先使用成熟的开源组件,不把业务代码绑定到单一云厂商。
- 组件边界通过接口和配置属性表达,便于替换数据库、缓存和模型供应商。