架构实战—软件架构设计的过程读后感(二)

读到第四章,又看到了熟悉的文档编写,哎,头疼,虽说头疼,但文档的编写能力也是考验一个程序员的重要科目,这不是我就在坚持写读书笔记嘛,晚上给自己加个鸡腿。

所话说,编码10分钟,文档2小时。那为什么在软件开发过程中,文档如此重要呢。

软件开发有以下几个主要的阶段(当然我这些肯定不是最全面的)。需求获取阶段——文档设计阶段——代码实现阶段——测试阶段——维护阶段,每一个阶段都离不开文档。

开发过程中把每一个细小的功能模块的详细实现都要写明白,所有的类图,流程图等等都要写明白,文档写的越细,你对业务逻辑的把控力就越强,对业务的理解就会越透彻,实现起来就会更简单。如果工作做的不细,对于没有经验的人来说,从宏观上去把控业务会有些力不从心甚至跑偏。

还有一点,文档如果足够详细和明白,就不用太担心项目换人。因为即使还了别人开发,他们也可以通过文档从整体上理解整个项目,这一点对于企业来说至关重要。

文档先于代码,这点是正确的,但这并不是说,在代码实现之前所有的文档都要写的清清楚楚。因为用户的需求永远都在变,或许用户连自己想要做什么都说不明白,更别说我们这些需求人员和开发人员了。所以有时候,软件的开发是一边写文档一边写代码的,在这种情况下,一定要注意一点:防止软件架构变动。不能让变化的用户需求改变了我们的架构。

在软件测试阶段,文档也显得尤为重要;单元测试需要参照模块详细说明书;集成测试要参照软件详细设计说明书;黑盒测试要参照用户使用手册;系统测试要参照需求规格说明书、软件详细设计文档,等等。其中,少了任何一个文档,测试人员都无法开始工作。

综上所述,文档真的是很重

posted @ 2020-04-12 15:00  _小白兔  阅读(144)  评论(0编辑  收藏  举报