pali-me

同步文档 (Sync Documentation) 是一项工程自动化工具，旨在确保项目文档能随代码库演进而保持准确且相关。通过利用 Git 差异 (diffs) 和提交记录 (commit logs)，此代理能识别具体的修改内容，例如数据库结构更新、测试套件调整或架构变更，并将其映射至 /docs 目录中的适当文档。此流程能有效缓解在快节奏开发环境中常见的文件滞后问题，因为功能实现往往快于手动更新文档。此工具适用于希望在无需手动追踪的情况下执行严格文档标准的软件工程师、技术主管与文档维护者。

• 自动检查分支专属的 Git 差异，以检测代码库中的结构性与功能性变更。

• 将不同的代码区域（如 db/ 迁移、tests/ 配置或依赖项变更）映射至对应的 Markdown 文档。

• 通过分析最近的提交消息来理解技术变更背后的逻辑，从而进行更具情境意识的更新。

• 通过验证交叉引用并确保代码示例反映当前实现，来提升文档的一致性。

• 可通过 Makefile 指令或直接在 Claude Code 中调用，无缝整合至开发者工作流程中，以便快速进行文档维护。

• 此工具预设项目具有标准目录结构，文档存放在专属的 /docs 文件夹中。

• 输入条件包括一个带有待处理变更的活跃 Git 分支，以及准备好进行更新的文档文件。

• 输出内容包括自动化提交或建议，这些提交会以简洁的解释和更新后的代码示例来修改文档文件。

• 用户应审查更新内容，以确保术语对齐并确认版本编号或日期已正确递增。

• 最适合使用 Jest、React Testing Library 等标准测试框架，以及如 Maestro 进行端对端 (E2E) 测试的项目。