| name | document-sync |
| description | 确保代码变更后及时更新相关文档。当代码更新、新增、删除或项目功能变更时,必须同步更新文档。 |
文档同步规则
功能说明
此技能确保所有代码相关的迭代都及时同步到文档中,包括:
- 代码更新
- 新增功能
- 删除功能
- 项目功能变更
- 升级迭代
触发条件
必须在以下情况调用此技能:
- 完成代码更新后(新增、修改、删除)
- 完成功能迭代后
- 完成项目升级后
- 修改了核心模块或 API
- 重构了代码结构
执行步骤
1. 确认变更内容
- 检查代码变更范围
- 确定受影响的模块
- 识别需要更新的文档
2. 更新文档
- 新增功能:在对应文档中添加新章节
- 修改功能:更新文档中的相关描述
- 删除功能:从文档中移除相关章节
- 代码重构:更新代码组织结构说明
3. 验证文档
- 确保文档与代码一致
- 更新使用示例
- 更新 API 文档
- 更新配置说明
4. 更新日志
变更类型与文档更新
代码更新
# 在对应文档中添加
## 新增功能
- 功能描述
- 使用示例
- 注意事项
代码删除
# 在对应文档中添加
## 已删除功能
- 功能名称
- 替代方案(如有)
- 迁移指南(如有)
功能升级
# 在对应文档中添加
## 功能升级
- 升级内容
- 新特性
- 向后兼容性
- 迁移指南
文档更新检查清单
示例
示例 1:新增中间件
src/litefs/middleware/new_middleware.py
docs/middleware-guide.md
示例 2:重构代码
mv src/litefs/old_module.py src/litefs/new_module.py
docs/architecture.md
docs/migration-guide.md
示例 3:删除功能
rm src/litefs/deprecated_feature.py
docs/deprecated-features.md
最佳实践
- 及时更新:代码变更完成后立即更新文档
- 完整更新:确保所有相关文档都已更新
- 准确描述:文档描述必须与代码实现一致
- 提供示例:更新使用示例和配置示例
- 记录变更:在文档中记录变更日期和内容
责任
- 开发者:在代码提交前确保文档已更新
- 代码审查者:检查文档是否与代码一致
- 项目维护者:确保文档同步规则得到执行