首页 » 程序员必读之软件架构 » 程序员必读之软件架构全文在线阅读

《程序员必读之软件架构》产品与项目文档

关灯直达底部

最后一点,我这里指的文档风格是跟所构建的产品有关,而不是创建/改变这个产品的项目 。和我一起工作过的一些组织有将近二十年的软件系统,尽管它们有不同数量的项目级 文档,其中却往往没有一个能讲述产品如何工作、如何演化。通常这些组织有只有一个产品(软件系统),每一次主要的变化都作为一个单独项目来管理,结果过去20年中产品发生了巨大的变化,为了解软件当前的状态,要消化相当数量的项目文档。在这样的环境中,新员工往往只能读读代码,跟踪不同项目组产出的文档来填补空白,这至少是浪费时间!

我建议软件团队为他们构建的每一款软件系统都创建一份软件指南。这并不意味着团队不应该创建项目级别的文档,但应该有一个地方可以让人找到关于产品如何工作、如何随着时间演化的信息。一旦有了这样的软件指南,改变一个系统的每一个项目/变化流/时间段就是一个小的增量。每款产品一份软件指南,使得了解软件当前的状态变得简单得多,也为将来的探索提供了非常好的起点。