# /doc-sync — 逻辑改动后文档同步 检查本次会话中的逻辑改动是否需要同步更新文档,并执行同步。 ## 触发条件 修改了以下任一类内容时应执行: - 业务规则/计算口径/资金处理(精度、舍入、阈值) - ETL/SQL 清洗聚合映射逻辑 - API 行为(返回结构、错误码、鉴权/权限) - 小程序关键交互流程 - 数据库表结构 ## 执行步骤 ### 第 1 步:分类 判断本次会话的改动是否属于"逻辑改动"。如果只是纯格式化/拼写修正/注释调整,告知用户"无逻辑改动,无需文档同步"并结束。 ### 第 2 步:逐项评估需要更新的文档 根据变更涉及的模块,评估以下文档是否需要更新: **各级 README.md**(只更新与本次变更相关的): - `README.md`(根目录):项目总览、快速开始、环境变量、架构概述 - `apps/backend/README.md`:后端 API 路由、配置、运行方式 - `apps/etl/connectors/feiqiu/README.md`:ETL 任务清单、开发约定 - `apps/miniprogram/README.md`:小程序页面结构 - `apps/admin-web/README.md`:管理后台功能说明 - `apps/tenant-admin/README.md`:租户管理后台功能说明 - `packages/shared/README.md`:共享包说明 - `db/README.md`:Schema 约定、迁移规范 规则:如果"对读者理解系统行为有帮助"就应更新。若某个 README 尚不存在但变更涉及该模块,应创建。 ### 第 3 步:执行更新 对每个需要更新的文档: 1. 读取当前内容 2. 根据本次变更更新相关段落 3. 写入更新后的内容 如果更新工作量大(>3 个文档),委托子代理处理。 ### 第 4 步:联动检查 - 如果涉及 DB schema 变化:提醒用户执行 `/db-docs` - 如果涉及 API 变化:检查 `apps/backend/docs/API-REFERENCE.md` 是否已更新 ### 第 5 步:输出摘要 - Changed:改了哪些文档 - Why:原始原因 + 直接原因 - Risk:风险点与回归范围 - Verify:建议的验证步骤