框架文档用什么写_我们为什么要写文档？

菜鸟程序猿问：昨晚就加两行代码，怎么搞那么晚？

老鸟程序猿答：思考半小时。写代码一分钟，写注释5分钟，测试半小时，写文档半小时。

今天在朋友圈发了这么一个小段子，大家都表示非常有感触。

这篇文章再给大家分享一下《我们为什么要写文档》

文档的作用：

Ø开发人员通过文档化的过程查错补遗；

Ø便于评审，在早期发现技术上的问题；

Ø后续阶段开发任务可能由他人承担，输出文档便于他们开展工作；

Ø维护人员开展维护工作需要；

Ø文档是必要的交付件，是产品的一个组成部分；

“所有的过程分析都要形成文档。我们现在有一个严重的问题是，大家好像不喜欢写文档，对于需要的实现方案，通常都是一个负责人在脑袋里想想该怎么实现，然后邮件或电话找几个相关人员讨论一下就算可以了，可能连个会议材料或会议纪要都没有。

而老外可不是这样的，他们非常非常重视文档，他们认为一个人在脑袋里想的东西是不清晰也不全面的，有时候心里想的认为很正确的方案实际上可能存在致命缺陷。他们要求必须把心里的想法形成文档才能有效的避免这种问题。写文档的过程中，可以更加有效的、更进一步去整理您原来心里的思路，很多问题在您写过文档的过程中您就能发现；另外，文档写作多使用图表，浪费口水的文字尽量少用，和我们一起工作的系统工程师在系统架构分析中就画了五六十张图，就算看不懂他写的英文，从图中我们就能够很清晰的指导整个产品的系统架构。”——摘自一位华为员工的瑞典出差报告

可见，文档是一种促发思考，辅助设计，查漏补缺，团队合作的重要工具

那么我们如何让文档写的规范而有效呢？我们不是为了写文档而写文档。而是在关键节点，做有效的关键动作，来完善设计。

“流程+模板。”是关键：例如，我们在各个研发的关键节点需要输出哪些文档，这些文档需要包含哪些内容。显得尤为关键。

另外，流程和模板的都是死的，但是需求和设计是活的。当现有的模板不能涵盖新设计的时候。需要设计者根据需求，补充现有的模板和流程。例如，我在设计一款刀片服务器的时候，X86系统呢的BIOS