52 lines
2.8 KiB
Markdown
52 lines
2.8 KiB
Markdown
---
|
||
name: steering-readme-maintainer
|
||
description: 当发生业务/ETL/API/鉴权/小程序交互等逻辑改动时，用于执行变更影响审查并同步更新 product/tech/structure/各级 README 与审计记录。
|
||
---
|
||
|
||
# 目的
|
||
将"逻辑改动→文档同步→审计留痕"流程标准化，减少漏更与口径漂移风险（资金相关场景优先保证可追溯与可复算）。
|
||
|
||
# 触发条件（何时调用本 Skill）
|
||
- 修改了业务规则/计算口径/资金处理（精度、舍入、阈值等）
|
||
- 修改了 ETL/SQL 清洗聚合映射逻辑
|
||
- 修改了 API 行为（返回结构、错误码、鉴权/权限）
|
||
- 修改了小程序关键交互流程（校验、状态机、关键字段）
|
||
|
||
# 工作流（必须按顺序执行）
|
||
## 1) 分类：是否属于"逻辑改动"
|
||
- 若不是逻辑改动：写明"无逻辑改动"，并说明为何（例如仅格式化/拼写修正/注释调整）。
|
||
- 若是逻辑改动：进入下一步。
|
||
|
||
## 2) Steering 与 README 同步（逐项评估）
|
||
|
||
### 2a) Steering 文件
|
||
- `.kiro/steering/product.md`：业务定义/口径/资金规则是否变化？
|
||
- `.kiro/steering/tech.md`：技术栈/运行方式/依赖/部署假设是否变化？
|
||
- `.kiro/steering/structure-lite.md`（摘要）/ `.kiro/steering/structure.md`（仅在目录树/边界变化时）：目录/模块边界/职责是否变化？
|
||
|
||
### 2b) 各级 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`：管理后台功能说明
|
||
- `packages/shared/README.md`：共享包模块说明、使用方式
|
||
- `db/README.md`：Schema 约定、迁移规范、种子数据说明
|
||
- `scripts/README.md`：各子目录用途、常用脚本说明
|
||
- `tests/README.md`：测试运行方式、FakeDB/FakeAPI 用法
|
||
- `docs/README.md`：文档目录索引
|
||
|
||
> 规则：只更新与本次变更相关的 README；如果"对读者理解系统行为"有帮助，就应更新；不要为了追求"少改文档"而拒绝同步。若某个 README 尚不存在但变更涉及该模块，应创建。
|
||
|
||
## 3) 输出审计友好摘要（对话回复/审计记录都需要）
|
||
- Changed：改了哪些模块/接口/表/关键文件
|
||
- Why：原始原因（Prompt-ID + 摘录）与直接原因（必要性 + 方案简介）
|
||
- Risk：风险点与回归范围
|
||
- Verify：建议的验证步骤（测试/SQL/联调）
|
||
|
||
## 4) 联动硬规则检查
|
||
- 如果涉及 DB schema/表结构变化：必须同步更新 `docs/database/`（见 skill `bd-manual-db-docs`）。
|
||
|
||
# 资产（可复制模板/清单）
|
||
见：`assets/steering-update-checklist.md`
|