文档恐惧症的分析

一、为什么不愿意写文档？

开发人员对编写文档的抗拒主要源于认为文档编写耗时，担心思想被评判，认为文档效果不佳，以及实践经验表明文档非必需。还有文档与实际实现不一致的问题，写文档需要写多份并进行评审，做出变更时需同步更新多份文档，这增加了工作量。一些人认为软件简单，无需文档即可记住需求，而CMMI或ISO认证导致文档被视为负担，另外有些人文本表达能力较差。

二、文档的作用是什么？

文档和口头交流是两种互补的沟通方式。口头交流特点包括即时性、综合性、高效性、双向性和模糊性。而文档的特点是正式性、严密性和可重复性。文档能够提供更严密、完备且无歧义的描述，适用于正式的沟通和验证。不过，文档不能解决所有沟通问题，需要与口头交流结合使用。无文档会导致理解不一致、沟通混乱、返工、维护困难等。

三、应该何时写文档？

文档编写应基于其目的，考虑是否需要文档、文档读者、内容、作者、编写时机等。例如，设计文档的编写取决于目的，如便于维护则编码后编写，评价设计思想时可用白板讨论，同时考虑QA审计时可能不需文档。如果目的包括评价设计思想和便于维护，则在编码前编写，并在设计变更时更新文档以保持一致性。文档编写还可以遵循基本规则，如团队人数、复用性、客户需求、新手比例、产品开发、承诺、开发周期等因素可决定是否编写文档。

玩转IPD（集成产品开发）之BLM模型，让团队开启上帝视角

了解更多

想要了解更多内容？

查看原文：文档恐惧症的分析

文章来源：

麦哲思科技任甲林

扫码关注公众号