成都公司:成都市成华区建设南路160号1层9号
重庆公司:重庆市江北区红旗河沟华创商务大厦18楼
当前位置:工程项目OA系统 > 建筑OA系统 > 工程项目管理软件系统
综合管理:从项目交接看项目文档管理
最近正在接手一个项目,就以此项目为例,说一下我的体会。这个项目已经开发完成,并且已经上线运行,具备了一定的客户群体。接手这个项目时,此项目只有成果,没有过程。仅有一份完整的用户手册。
针对此情况,提出要求,需补充以下文档:
一、《成果说明文档》:需说明当前所有可提交成果、成果内容描述及成果评估。
成果描述至少需要描述以下内容:
1) 成果存在形式及现状:针对软件项目而言,基本上成果都是以可运行代码形式存在,但在此一定要明确说明代码的现状,是否经过测试,如果经过测试,需提交相关的测试报告,如果没有经过测试,那是否已经完成,完成后,如果未完成则进行到什么程度,尤其是如果没有注释的代码,应明确交代代码实现的功能描述及接口描述。
2) 成果研发过程说明:主要说明成果的追溯过程,此代码从何而来,是否具备相应的计划内容,如果没有,这成果的上一个环节是什么,以代码为例,代码上一个环节是否有设计,设计上一个环节是否有需求分析等等。这部分代码是根据什么来进行的研发。如果某个成果没有追溯到最初环节,就需要注意了,这部分内容就是风险了。
3) 成果可用性说明:并不是最终提交的成果就一定是有效、可用的。也许会隐藏很多的问题,这需要任务的相关承担人进行可用性描述,我们作编码的都知道,在特定的情况下,可能会采用一种临时方案去实现一个功能,等最终集成时再去修正,但很多情况下这种临时方案都成为了最终方案。所以,一定要对成果进行有效性说明,如果没有的,就一定要进行严格的测试验收。
4) 成果责任人说明:一定要有,不是追究责任,而是便于沟通。
文档制作说明:
此文档建议采用表格进行说明,如果可以建议采用Excel,这样便于使用跟踪管理,如下:

如果没有计划管理文档的话,补充的时候,则建议采用Project来完成,前一个成果提交文档,并且最好可以采用WBS来组织任务的安排,将已经提交的对应到相应的任务中。通过前一文档状态的说明,将未完成的内容做标记,并且看是否存在同样的任务不同的成果表现形式的情况,这时应该是属于重复性任务,也做标记说明。
三、《需求说明书》:需说明产品的最初需求内容实际对于我当前接手的这个产品,需求说明书的重要性已经大大降低了,因为产品已经研发完成,且提供了完整的用户手册,但整理需求说明书的主要目的还是有两个:
1、是要建立完整的项目过程追溯流程,为后续工作做准备。
2、通过需求验证成果的有效及可用性。
需求说明书是一个可简可繁的一个文档,在这个项目中,需求说明书更多的是从用户手册中来提取需求了,实际的意义并不是很大。但如果是做一个新的项目,则需求说明书应该是仅最大可能的对用户业务进行一种还原描述,不要掺杂个人的理解。至于是否可以实现,怎么实现是后续工作的事情,不是这个环节的内容。
四、《系统设计说明书》:系统设计说明书现在在这个时候已经无法在考虑设计的问题,但此时应该提供以下内容:
1、系统的架构设计及架构在应用过程的调整。并且最好可以提供架构的弊病分析说明。
2、接口设计说明及接口的详细规格及设计说明。现在的系统基本上都是松散的,通过接口标准从而最终实现系统的集成,所以,接口部分非常关键,这部分内容一定要非常清晰和准确。
3、如果现在无法再提供设计文档,则建议通过第三方工具,根据成果代码反项生成设计,并在此基础上进行文档补充,看设计总比看代码好很多,所以,这部分内容应该进行提供。如果在新项目中,此部分内容页建议考虑,主要是规划接口调用、对象职能及对象关系。
五、《数据库设计说明书》
我本人还是十分重视数据库设计的,虽然现在有很多的DAO的工具,而且也倡导对象建模,但实际在应用过程中,完全做到的却是少之又少,尤其是针对数据分析部分内容。所以此文档我认为还是非常重要的。至于文档的格式,因为此方面已经非常“标准”化了,就不在进行说明了。

