必须写的程序设计文档。(为什么要进行程序设计?续)
程序员文章站
2022-03-25 15:23:20
...
软件功能的一些信息是无法包含在代码里的,比如:
1.基于用户环境抽取的数据格式信息。
2.用户录入的具有特定业务含义的数据格式信息。
3.平台支持用户自定义数据结构,而代码硬编码了用户定义的字段。
4.特定业务需求导致的特定功能。只从代码无法反向理解功能含义。
在这些情况下,如果不仔细维护这些代码之外的信息,代码在不远的将来,老员工一旦流动,软件的修改就会遇到巨大困难。
尤其对于有产品化计划、开发实施分离的软件(可以跨多用户环境使用),信息丢失,导致的重复造*工作(重新梳理已开发功能的业务场景、理清数据结构和数据含义、然后按新的情况调整),就是灾难。
上述信息,维护到程序设计文档里,是很自然的事情。另外,数据库中用数字代表的枚举类型信息,数据库字段含义,也对软件维护起关键作用。
因此:编写程序设计文档是必须的。
接手公司一个产品三年半了,今天又发现大量无法理解的代码(项目上实现的),这部分功能如果给用户使用,必然又得折腾一遍,有感而发!
1.基于用户环境抽取的数据格式信息。
2.用户录入的具有特定业务含义的数据格式信息。
3.平台支持用户自定义数据结构,而代码硬编码了用户定义的字段。
4.特定业务需求导致的特定功能。只从代码无法反向理解功能含义。
在这些情况下,如果不仔细维护这些代码之外的信息,代码在不远的将来,老员工一旦流动,软件的修改就会遇到巨大困难。
尤其对于有产品化计划、开发实施分离的软件(可以跨多用户环境使用),信息丢失,导致的重复造*工作(重新梳理已开发功能的业务场景、理清数据结构和数据含义、然后按新的情况调整),就是灾难。
上述信息,维护到程序设计文档里,是很自然的事情。另外,数据库中用数字代表的枚举类型信息,数据库字段含义,也对软件维护起关键作用。
因此:编写程序设计文档是必须的。
接手公司一个产品三年半了,今天又发现大量无法理解的代码(项目上实现的),这部分功能如果给用户使用,必然又得折腾一遍,有感而发!