乐于分享
好东西不私藏

程序员愿意为 Claude 写文档,却不愿为同事写

程序员愿意为 Claude 写文档,却不愿为同事写
《Higher-Order Perl》这本书的作者 Mark Dominus写了篇文章,讲他在用 Claude 做项目时,会让 Claude 维护一份"交接文档"(handoff doc),方便下一个 Claude 会话快速上手。

他在论坛上看到一个常见吐槽——程序员愿意精心写 CLAUDE.md / PROJECT.md 给 AI 看,却不愿给同事写文档。

这让他意识到:是不是可以把 Claude 的交接文档直接提交到代码仓库呢?

于是他开始尝试这么做,流程大概是这样:

1. 项目结束后,让 Claude 从头写一份高质量的项目总结(不是流水账,是结构化概述)

2. 自己认真审阅、修改后 commit 进 repo

3. 未来有人用 git grep 翻代码时就可以看到有用的信息了

建议下面两种内容可以直接贴到 commit 描述里的

• 任务结束后,让 Claude 记的笔记

• Claude 写的项目总结

 Claude 写的总结质量还不错,十秒生成,审阅花不了一小时。

但是有个小坑:Claude 曾照抄了上一份报告末尾他自己加的"Approved-by"段落,他发现时已经审完了,所以好像也算没错……

从这段经验可以知道,AI 能解决"没人愿意写文档"的老问题——让 AI 写,人来审,顺手就提交了,不用专门花时间去梳理项目情况,费时费力去写。

看完他这个,我感觉还挺有价值,于是让 AI 提取了一份 skill,准备自己也试试,除了能让别人了解项目的来龙去脉,还能让不同的 AI 对项目的了解有个全貌,也是一种解决 AI 协作问题的好方法。而且commit不占上下文,需要的时候让AI查一下就好了。

参考文献:

https://blog.plover.com/2026/03/09/#documentation-wins-2

如果对你有帮助,点个在看 👇 让更多人看到

声明:本文为Canace 原创,不代表平台观点,未经许可禁止转载。