AI时代程序员文档习惯转变：为Claude而写

几天前，我提到了一种常见的抱怨：

我总是看到程序员说，大家愿意为了让 Claude 使用而编写详尽的 CLAUDE.md 和 PROJECT.md 文件，却不愿意为自己的同事编写这些文档，这让他们非常恼火。

对于规模较大的项目，我现在会让 Claude 维护一份交接文档，供下一个 Claude 阅读，说明我们计划做什么、已经完成了什么，以及其他相关信息。这样，当我关闭一个 Claude 后，就可以让下一个 Claude 阅读这份文件，迅速了解项目情况。然后，我会让 Claude !!n+1!! 更新它，交给 Claude !!n+2!!。

多次看到这种常见抱怨之后，我突然有了一个让人高兴的灵感。以前，每个项目结束时，我都会把 Claude 的交接文档扔掉。为什么要这么做呢？把文件复制到代码仓库并提交，根本不费什么事。将来某个人想弄清楚当时发生了什么，也许能幸运地通过 git grep 找到正确的文档，并从中获得一些有用的信息。

我的反应有点慢，直到这周才想到一个更好的做法：现在项目结束时，我会让 Claude 从头编写一份详细但保持高层视角的说明，解释我们要解决什么问题，以及做了哪些改动，然后把它提交到仓库。这不只是一份过程记录，而是对整个项目的结构化概述。

在提交这些概述之前，我会仔细审阅，并根据需要进行修改。commit 上签的是我的名字，薪水也是打进我的银行账户，所以任何没有经过我认真阅读和理解的内容，都不会进入代码仓库——就像 Claude 是一名由我负责监督的人类程序员一样。

不过，Claude 写的说明并不需要太多修改。Claude 最近写的一份项目总结，质量和我自己写出来的大致相当，也许稍差一点，也许还稍好一点。但它只用了十秒，而不是一个小时；审阅它也远远用不了一个小时。

上一次真正需要我认真修正的问题是：Claude 参考了之前一份相关报告，而那份报告的末尾有一段我后来添加的文字：

Claude 根据我们对这个问题的讨论整理出了这些笔记。Mark Dominus 已经阅读、审查、编辑并批准了这些笔记。

Claude 的新文档末尾也出现了一模一样的段落。糟糕！幸运的是，等我看到它时，这段话已经符合事实，所以不必删除。我让 Claude 在 CLAUDE.md 中加了一句话，告诉它以后不要再这么做。

今天的建议是：

如果你让 Claude 记录了笔记，完成工作后就把它们提交到代码仓库。这样做大概不会有什么坏处，而且可能会有帮助。

如果你让 Claude 记录了笔记，完成工作后就把它们提交到代码仓库。这样做大概不会有什么坏处，而且可能会有帮助。

让 Claude 编写一份项目总结，然后把它提交到代码仓库。

让 Claude 编写一份项目总结，然后把它提交到代码仓库。

也许这件事显而易见？但对我来说并不是。我还在适应这个新世界。

[分类 /tech/gpt 下的其他文章] 永久链接