乐于分享
好东西不私藏

代码在变,文档在烂:让文档跟着分支走

代码在变,文档在烂:让文档跟着分支走

代码在变,文档在烂:让文档跟着分支走

AI 写代码太快,文档很容易烂。

现在用 AI 写代码,功能唰地就改完了。但写文档、改文档的速度没跟上。结果就是代码天天变,架构说明却停在几个月前。

开源项目 Truthmark 想治这病。它的法子很直接:把文档塞进 Git,跟着代码分支走。

同一条时间线:文档和代码放一起。同一个分支,同一次提交,再也不会对不上。
进 PR 一起审:改代码时顺带改文档。提交代码审查时,文档改动也跟着一起审。
不搞额外系统:它不建外部知识库,也不搞向量库。全押在 Git 上,克隆下来就能用。

不过这方案也有短板。跨仓库的知识、图片这类非文本资产,它就管不了了。

而且这项目目前才八十多颗星,还是个刚起步的半成品。宣称的自动同步等能力,还得靠实际跑一跑验证。

让文档跟着代码一起演进,这个思路确实站得住。

原文代码在变,文档在烂:让文档跟着分支走
作者提示: 内容由AI生成
黑龙江,41分钟前,