标签： 文档
Google 的设计文档
设计文档是解决软件项目中最棘手问题时，实现清晰沟通和达成共识的有效工具。它们能节省成本，因为通过前期调研可以避免陷入无法实现项目目标的编码死胡同；但它们也需要成本，因为创建和审核需要时间。因此，请根据项目需求谨慎选择！
战争故事：我调试过的最难的错误
突然间，在没有任何明显原因的情况下，谷歌文档出现了大量错误。我和同事花了两天时间才解决了我调试过的最难的错误。
编程大牛的回答
编程大牛的回答
优秀软件设计文档最佳实践
作为一名软件工程师，我花了很多时间在阅读和撰写设计文档上。在磨砺了数百篇文档之后，我发现，优秀的设计文档与项目的成功之间有着密切的联系。
码农不重视文档：开源项目深受其苦
GitHub 刚刚发布了《2017 开源调查》报告，这家知名编程社交网站走访了 github.com 社区内 3800 多个项目和超过 5500 名成员，并且与 500 名在 GitHub 项目生态系统之外的编程者们进行了交谈。本次调查涉及多方面，比如人们在为开源项目做开发、做贡献时遇到的问题，结果有 93% 的人对“不完整或令人困惑的文档”感到非常沮丧。
阮一峰：中文技术文档的写作规范
英语世界里，文档非常受重视，许多公司和组织都有自己的文档规范，清楚地规定写作要求，比如微软、MailChimp、Apple、Yahoo、docker、Struts 等等（维基百科有一份完整的清单）。中文的也有不少，但都不令人满意，要么太简单，要么不太适用。我就动手，参考上面的规范，也结合自己的实践，总结了一份简单的《中文技术文档的写作规范》。
这样的代码才是好代码
好的代码，就像是好的笑话——无需解释就能让别人明白。如果你的代码能够做到不解自明，在大多数时候，你根本无需为其配备说明文档。
你讨厌写设计文档，但它却是必须的
大部分的程序员都是白痴，而余下的那部分都是狗屎。有时候我会觉得自己两者都属于，所以我敢信心十足的这么说。
