1f6dcbe2dce383b424823c65b4c2bf8d696c588c
团队文档中心(docs/)
前后端统一架构、编码标准、接口契约与 agent 协作边界的单一权威来源。 对应仓库:
abacus-static-framework(Vue 前端底座)·abacus.springboot.example(Spring Boot 微服务模板)
文档导航
| 文档 | 内容 | 读者 |
|---|---|---|
| coding-standards.md | ★ 前后端开发约束规范(权威):架构边界、APP_NAME 四处一致、前端规范、后端规范、接口契约、AI 生成检查清单、§9 SaaS 多租户约束 | 全体成员 + AI |
| architecture.md | 动静分离架构总览、技术栈、交付链路、治理体系、§7 SaaS 多租户架构 | 新成员 onboarding |
| agent-guide.md | AI 生成代码工作流(界面→代码提示词协议)、联调纪律、Vibe Coding 协作约定 | 全体成员 + AI |
| README.md(本文件) | 文档中心索引与交叉引用映射表 | 所有人 |
交叉引用映射表(单源化)
共享约束只允许存在于 docs/;各仓库
.project.agents/docs/context/只写指针与仓库特有内容,禁止复制正文。维护共享内容时先改 docs/,再同步各仓库指针。
| 主题 | 权威位置 | 被引用于 |
|---|---|---|
| 前后端共享约束(命名/契约/工作流) | docs/coding-standards.md |
前端/后端 CONVENTIONS.md、CLAUDE.md |
| 动静分离架构链路 | docs/architecture.md |
前端/后端 ARCHITECTURE.md |
| AI 协作与界面→代码协议 | docs/agent-guide.md |
前端/后端 VIBECODING_GUIDE.md、AGENTS.md |
| 前端特有约定(标准件清单/页面模式) | 前端 .project.agents/docs/context/CONVENTIONS.md |
前端开发 |
| 后端特有约定(分层模板/SQL/打包) | 后端 .project.agents/docs/context/CONVENTIONS.md |
后端开发 |
| 升级日志 | 后端 src/main/resources/doc/升级日志.md |
发布记录 |
快速上手(新成员 / 新任务)
- 读
architecture.md了解整体形态。 - 开发前通读
coding-standards.md(尤其 §3 APP_NAME 与 §6 接口契约)。 - 由 AI 生成代码时,按
agent-guide.md §2提供界面与业务说明,AI 遵循 §7 工作流并回附交付说明。