扫码阅读
手机扫码阅读

文档恐惧症的分析

20 2024-10-02

我们非常重视原创文章,为尊重知识产权并避免潜在的版权问题,我们在此提供文章的摘要供您初步了解。如果您想要查阅更为详尽的内容,访问作者的公众号页面获取完整文章。

查看原文:文档恐惧症的分析
文章来源:
麦哲思科技任甲林
扫码关注公众号
文档编写摘要

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

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

二、文档的作用是什么?

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

三、应该何时写文档?

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

想要了解更多内容?

查看原文:文档恐惧症的分析
文章来源:
麦哲思科技任甲林
扫码关注公众号

麦哲思科技(北京)有限公司总经理 敏捷性能合弄模型评估师 认证的Scrum Master 认证的大规模敏捷顾问SPC CMMI高成熟度主任评估师 COSMIC MPC,IAC 成员,中国分部主席

420 篇文章
浏览 63.3K
加入社区微信群
与行业大咖零距离交流学习
软件研发质量管理体系建设 白皮书上线