doc-updater

doc-updater 技能是一款主动式文档维护工具，专为需要维持代码与技术文档同步的软件开发人员与技术主管所设计。通过分析 Git 差异与应用模式匹配启发法，代理程序能识别项目中需要更新的特定区域（如 CLI 接口、API 端点、环境变量与配置模式），以确保文档内容准确。此工具能自动化将代码修改与 README.md、CHANGELOG.md 及 docs/ 文件夹中的文档进行交叉比对的繁琐过程，减轻开发人员的认知负担。对于遵循严格版本控制工作流程或预合并检查清单 (pre-PR checklists) 的团队特别有效，确保文档不是事后才处理的工作，而是开发周期不可或缺的一部分。

• 使用正则表达式模式自动扫描变更的代码，识别修改后的 API 路径、新增的 CLI 选项或更新后的环境变量。

• 提供结构化的 Markdown 格式建议，并使用 diff 风格语法，使变更的应用过程变得无缝衔接。

• 与标准存储库结构集成，支持 Markdown、README 文件、API 规范与配置指南等多种文档类型。

• 具备内置的交互式工作流程，提供「文档影响报告」，让用户在执行前能审核并核准特定的更新建议。

• 鼓励最佳实践，确保针对重大变更、新功能与安全性补丁及时更新 CHANGELOG。

• 促进与代码质量检测 (code-quality-gates) 及自动化 PR 检查清单工具等二次工具的集成。

• 适合在 Python 环境中开发，或在存储库中直接维护文档的项目开发人员使用。

• 工具运行前提是项目中需包含既有的文档文件（例如 .md 文件、docs/ 目录）。

• 使用如 git diff 的标准 Git 操作来跟踪变更，因此最适合在已初始化的存储库中使用。

• 尽管在结构化更新方面非常有效，用户仍应对需要代码本身未涵盖之领域特定知识的复杂文档变更进行手动验证。

• 支持通过技能配置中的 Python 脚本自定义检测模式，以针对特定项目需求调整探索规则。