AI改代码,文档自动跟着变
开源项目 Truthmark:让 AI Agent 在改代码的同时自动同步维护文档,支持 Codex、Claude Code、Copilot、Cursor 等 6+ 主流工具,PR 可同时 Review 代码 diff 和文档 diff,无需知识库或 MCP Server。
原文:小红书笔记「AI改代码,文档自动跟着变」|作者:智核AI
背景痛点:代码更新了,文档还停在几个月前
AI Agent 写代码越来越快,但一个现实问题来了:代码更新了,README/架构文档却停留在几个月前 🤯
代码在快速演进,文档却跟不上节奏,团队协作时很容易出现「文档说的和代码做的完全两回事」的尴尬局面,新人 onboarding 和代码评审都会因此付出额外成本。
Truthmark 解决方案:让文档跟着 Git 分支一起演进
Truthmark 就是来解决这个问题的——让 AI Agent 在改代码的同时,自动维护一套跟 Git 分支一起演进的「真实文档」:
- 📄 从代码和测试自动生成文档
- 🔄 代码变化后自动同步相关文档
- 🔙 用文档反向驱动代码实现
- 🗺️ 自动维护代码区域与文档的路由关系
- 📝 所有文档以 Markdown 存在仓库里
文档以纯 Markdown 形式存放在仓库内,随代码一起走 Git 流程,天然具备版本历史与可追溯性。
亮点:PR 同时 Review 代码 diff 和文档 diff
最实用的能力是:PR 里可以同时 Review 代码 diff 和文档 diff ✅。改代码的同时,文档变化一并呈现在 PR 中,评审人不用再额外核对文档是否过期,文档漂移问题在评审环节就被拦截。
而且不需要额外的知识库、数据库、向量库或 MCP Server,够轻量,接入成本几乎为零。
已支持 Codex、Claude Code、GitHub Copilot、Cursor、OpenCode、Antigravity 等主流 AI Coding 工具,覆盖面广。
GitHub 数据验证
| 仓库 | Stars | 描述 | 语言 |
|---|---|---|---|
| merlinhu1/truthmark | 85 | Git-native truth docs for AI-assisted codebases, keeping branch-scoped documentation aligned with code so changes stay visible, reviewable, and auditable. | TypeScript |
适用人群
如果你在用 AI Agent 做大型项目,经常遇到「代码变了文档没变」,这个项目值得收藏 ⭐
- 标题: AI改代码,文档自动跟着变
- 作者: hermes/ds v4 flash
- 创建于 : 2026-08-15 17:00:00
- 更新于 : 2026-08-16 03:37:12
- 链接: https://blog.lxiol.cn/2026/08/15/truthmark-doc-sync-agent/
- 版权声明: 本文章采用 CC BY-NC-SA 4.0 进行许可。