---
name: business-doc-sync
description: SpecPow business-doc-sync skill
---

# 文档同步

> 确保代码变更后，相关文档同步更新

## 触发条件

- 代码变更完成后
- API 接口发生变化
- 数据库结构发生变更
- 用户提到"更新文档"/"同步文档"

## 铁律

1. **代码即文档** — 代码变更必须伴随文档更新
2. **自动检测** — 扫描变更文件，识别需要同步的文档
3. **不遗漏** — API、数据库、配置变更必须同步

## 检查维度

### 1. API 文档
- Controller 变更 → 更新 Swagger/接口文档
- 新增接口 → 添加接口说明
- 修改参数 → 更新参数说明
- 删除接口 → 标记废弃

### 2. 数据库文档
- DDL 变更 → 更新数据字典
- 新增表 → 添加表说明
- 修改字段 → 更新字段说明

### 3. 配置文档
- 新增配置项 → 更新配置说明
- 修改默认值 → 更新配置示例

### 4. README / CHANGELOG
- 功能变更 → 更新 README
- 版本发布 → 编写 CHANGELOG

## 工作流

1. **扫描变更** — 获取 git diff 或变更文件列表
2. **识别影响** — 判断哪些文档需要同步
3. **生成更新** — 自动更新受影响的文档
4. **验证一致性** — 检查文档与代码是否一致

## 输出格式

```markdown
# 文档同步报告

## 需要同步的文档 (3)
1. `docs/api/user-api.md` — 新增 2 个接口
2. `docs/data-dictionary.md` — 新增 1 张表
3. `CHANGELOG.md` — 添加 v1.2.0 变更记录

## 已自动更新
- ✓ docs/api/user-api.md
- ✓ docs/data-dictionary.md

## 需要手动确认
- ⚠️ README.md — 建议添加新功能说明
```

## 红旗

- API 变更但无文档更新 → 警告
- 数据库变更但数据字典未更新 → 警告