Skip to content

研发文档

适用对象

供 OARS 开发、测试、运维和 AI 辅助任务参考。记录研发入口和关键约定。

入口

  • 架构:development/architecture/
  • 表单与流程引擎:development/engines/
  • 后端:development/backend/
  • 前端:development/frontend/
  • 接口:development/api/
  • 数据库:development/database/
  • 代码生成:development/code-generator/
  • AI 协作:ai/

关键约定

  • 先查真实入口:后端看 oars-java,前端看 oars-web/apps/web-antd,生成器看 oars-tools
  • 代码生成、前端页面、流程、移动端任务开始前,先读 docs/ai/skills 对应规则。
  • 标准 CRUD 优先走 oars-tools;复杂业务、外部集成、特殊交互再进入源码二开。
  • 客户源码二开优先放在扩展边界内;确需改核心模块时必须保留补丁说明,并评估是否回合产品主线。
  • 源码插件进入客户交付时必须保留 manifest、delivery descriptor、SQL 和生成源码,并执行交付检查。
  • 只提交本次负责的文件;脏工作区中避免回退或覆盖他人改动。

实现位置

  • 后端 Maven 聚合:oars-java/pom.xml
  • 后端启动模块:oars-java/oars-app
  • Flyway SQL:oars-java/oars-migration/src/main/resources/db/migration
  • 前端应用:oars-web/apps/web-antd
  • 生成工具:oars-tools
  • AI 规则:docs/ai/skills

待确认事项

  • 文档站后续是否补“模块级研发索引”,例如流程、表单、文档、消息。