Files

华佗 3578a24254 docs(specs): 汇总铁律和前后端开发规范文档到MD目录

- 新增 MD/specs/IRON_RULES.md — 执行铁律汇总(v2.0, 8条铁律)
- 新增 MD/specs/BACKEND_DEVELOPMENT_STANDARD.md — 后端开发规范
- 新增 MD/specs/FRONTEND_DEVELOPMENT_STANDARD.md — 前端开发规范
- 新增 healthlink-his-ui/AGENTS.md — 前端铁律引用
- 更新 healthlink-his-server/AGENTS.md — 同步规范文档引用
- 修复10个文档缺失的元数据(文档类型标签)
- 全部30个文档通过命名规范和元数据检查

2026-06-06 09:33:20 +08:00

2.4 KiB

Raw Blame History

HealthLink-HIS 铁律

铁律 #1: 修改完必须测试

任何代码修改后，必须完成以下测试才能提交：

白盒测试

mvn clean compile 编译通过
单元测试通过（如有）

黑盒测试

启动应用，验证无启动报错
测试关键接口（登录、核心业务接口）
验证请求响应正确

冒烟测试

应用正常启动（端口监听）
健康检查接口返回正常
基础 CRUD 操作正常

铁律 #2: Flyway 迁移

但凡遇到有新建表和字段的，通过 Flyway 框架去实现。

铁律 #3: 先分解再行动

任何非平凡任务先出 plan 再执行。

铁律 #4: 验证后信

每次修改后必须验证编译通过，不信记忆。

铁律 #5: 文档统一管理

所有文档必须存储在 MD/ 目录中，遵循以下规范：

目录结构

MD/
├── architecture/    # 架构设计
├── development/     # 开发计划与记录
├── standards/       # 国家/行业标准
├── specs/           # 技术规范与流程
├── bugs/            # Bug分析与修复记录
├── guides/          # 使用指南
└── upgrade/         # 升级记录

命名规范

文件名使用大写英文+下划线（如 GRADE3A_DETAILED_DESIGN.md）
不使用中文作文件名
不使用空格分隔单词
版本号标注在文件名末尾（如 _V2）

格式要求

文档头部必须包含元数据块（文档类型、版本、日期）
代码块必须标注语言类型
表格使用标准Markdown格式

详细规范

参见 MD/DOCUMENTATION_STANDARD.md

铁律 #6: 测试通过后才提交

代码修改必须通过完整测试后才能提交到远程仓库。

铁律 #7: 前后端API路径对齐

前后端API路径必须保持一致。

后端接口路径统一前缀：/healthlink-his/
接口变更必须同步更新前后端代码
新增接口必须在 Swagger 文档中注册

铁律 #8: 规范文档统一管理

所有铁律和规范文档存放在 MD/specs/ 目录中：

MD/specs/IRON_RULES.md — 执行铁律（完整版）
MD/specs/BACKEND_DEVELOPMENT_STANDARD.md — 后端开发规范
MD/specs/FRONTEND_DEVELOPMENT_STANDARD.md — 前端开发规范
MD/specs/BACKEND_CHECKLIST.md — 后端发布检查清单
MD/specs/FRONTEND_CHECKLIST.md — 前端发布检查清单

2.4 KiB Raw Blame History Unescape Escape