当程序员说"文档写得很清楚"时

经典场景重现

产品经理："这个API文档我看不太懂..."

程序员："文档写得很清楚啊！"（一脸无辜）

产品经理："那为什么只有你能看懂？"

程序员："因为...我就是按照我的思路写的啊！"

程序员文档的隐藏规则

• 每个参数都用缩写，比如"usrPref"表示"用户偏好设置"
• 关键步骤永远用"显而易见"一笔带过
• 最重要的部分写在"注意事项"的小字里
• 版本更新从不更新文档，但会更新代码

真实案例

某公司新入职的程序员接手一个项目，看到文档上写着：

"调用processData()后会自动处理所有数据"

三天后，系统崩溃了。原开发者回来查看时说：

"我不是在文档里写了要先用initEnv()初始化环境吗？就在第38页的脚注里！"

如何判断文档是否"清楚"

1. 如果你能看懂，说明你是作者
2. 如果你看不懂但假装懂了，说明你是资深程序员
3. 如果你直接问作者，说明你是新人
4. 如果你重写了一套文档，说明你是CTO

终极解决方案

当有人说"文档写得很清楚"时，最好的回应是：

"太好了！那你来给我们讲解一下吧！"

这时通常会看到以下表情：? → ? → ?