撰写代码是程序员的本职工作，但编写文档时至今日依然常常遭到忽视。纵有高人曰过，优雅的代码是最好的文档，但先不说多少人的代码能达到这般境界，许多事务并不能仅靠代码本身完成。例如：用户文档，不能倚赖用户去阅读代码后再使用你的系统；设计文档，需要快速纵览项目时并无闲暇去阅览数万行代码；需求文档，乙方不可能按着你的 API 接口声明猜测你的意图……然而，几乎每一个程序员都被文档的匮乏深深伤害过。

[……]

阅读全文