同一个项目的不同的项目工作经验总结--设计文档编写经验总结

 

 

深度设计文档编写工作经验总结

l 概述

临安自来水公司项目需要，由公司派我过来编写设计文档，由于本人对设计文档没有编写的经验，
当初还有些担心，能否完成公司交给我的任务，对自己一点信心都没有。查看过公司其他项目深度设
计文档编写报告后，对我的影响很大，感觉文档编写很简单，就是将客户的需求和公司按照需求编写
好的程序界面抓抓图，将各个模块的流程图画好就可以了。但是到了临安后，编写出的文档远远与项
目经理要求的文档有很大的差别。最后定下按照日本设计文档编写模板进行编写，在这期间项目经理
指点很多文档编写技巧。编写完第一个模块，经理也很对第一个模块的编写成果也得到了认可。
（得到认可是用时间培养出来的，第一个模块完成，整整用了一周的时间。）

l 经验总结

下面将我两个月编写文档的经验，和与用户交流的经验进行总结。

一、        文档编写

1、 制定文档模板：

    工程项目中有很多模块需要编写，文档编写人员一定要与项目经理和客户确认好文档的格式。
最好的办法是先编写一个小模块的设计文档，提交到项目经理和客户手中，是否能得到项目经
理和客户的认可。认可后，在统一编写其他模块的设计文档。

2、 编写文档注意事项：

1）、详细阅读客户需求，理解客户的要求很重要，因为后期与客户进行产品对接时，客户要
按照客户需求的招标文件书来进行对接。所以一定要按照客户需求编写文档。

2）、与研发人员沟通，研发人员也是根据客户需求进行编写功能界面的，所以研发人员是比
较了解客户需求的。根据研发人员需求理解信息，在与标书需求进行对照，如果完全一直，
则编写文档，如果有不相同的地方，要与项目经理确认，来解决分歧。如果还有问题存在，
就得与客户进行交流确认。文档编写需要研发人员配合，遇到要更改的页面时，一定要说明
更改原因，说服研发人员修改，不要强制研发人员修改，一定要保持良好的工作环境。

3）、与客户沟通，首先要了解客户这个模块的需求，并将现在不理解的需求讲解明白（主要
是不明白在什么地方，加一些自己的建议和想法）。让用户来协商该模块的负责人来确认相关
问题，并将确认相关结果记录下来，并将协商结果在给客户说一遍。确认完毕后编写文档，

4）、文档排版，在编写完文档后，要详细检查文档排版是否有问题。如：目录更新、各个章
节编号、页码是否正确、图标是否正确等。不要因为排版问题来影响最后的签字。

5）、文档修改后一定要填写修改日志。

二、        与客户对接

1）、对接页面功能时，总会出现上次问题没有修改的现象。在这个项目里面也出现该现象，这个
我也有责任，第一次对接都要求研发人员记录，自己没有记录下来，认为自己已经了解了客户要
更改的地方，不会忘记。到最后发现，忘记很多要修改的地方。所有设计了一个对接表格，流着
下次对接使用。

XXX项目对接表格
模块名称	界面编码	修改前	修改后	备注
工程模块	0601（2）	没有修改按钮	增加修改按钮

模块名称：主要是对接模块名称填写，在打印之前可以进行编辑。

界面编码：可以根据模块进行编排，自己自行定义，因为自己定义可以很清楚了解是那些页面。与客
户对接时未必所有页面都需要修改，不建议打印前编写号，希望在对接时手工录入。建议界面编号，
如：子模块有10个，可以按照先后顺序进行编排，每个子模块子模块下面都有相关的功能页面，也是
按照页面的先后顺序进行编排，如第5个子模块，第6个页面，编号可以是0506，前面也可以加上该模
块的总编号，如工程模块编号为06，上面的例子就是060506，这样统一后就很快将记录的修改内容。
这样就不会漏掉要修改的内容，准确定位到修改的界面。珍惜客户劳动成果。

2）、对于客户新增功能不要反驳客户，并将新增功能记录下来，并讲明新增功能需要的时间和人力物理。

三、        个人提升

1）、客户需求定制开发流程：

    由于以前工作环境限制，很少接触后台开发人员，对定制开发项目不是很了解。通过这次经历，已
经了解到一个定制开发项目如何开展工作，工作分配等相关的知识。如：项目经理确认好客户需求后，
将任务分摊到每个研发人员手中，研发人员根据需求来进行开发不同的功能页面。最后项目经理对开
发好的功能页面进行测试，并提出修改意见，对功能页面进行重新编写或修改。最后与客户最终确认
编写好的功能模块。如果中间出现分歧，可以直接与客户进行沟通，解决问题。

2）、设计文档的重要性：

    设计文档编写是项目第一重要环节，只有客户对设计文档确认后，才能进入到产品代码开发阶段。设
计文档完成，得到客户的确认是第一个里程碑，也是项目下一个环节开始的重要依据。

3）、设计文档内容的重要性：

    内容包括如下：1、客户需求、流程图、与其他模块的联系图、数据库结构和页面功能介绍等。由于
前期没有与客户对每个模块一一沟通，导致第一次编写文档内容比较单一，主要是根据需求将页面功能
进行描述，没有更好的将每个页面的功能和与其他模块或页面的关系讲清楚，每个模块功能模块和每个
界面存在的意义和价值都没有明确的说明。在后期对部分文档添加了相应的描述，但不是全部。如果今
后还有相应的设计文档编写，一定会按照以上的内容进行编写。提高设计文档的编写质量。由于深度理
论设计不是很了解，在今后的工作中一定加以完善，添加到设计文档中。

4）、自来水公司业务流程

    已经深度了解了自来水公司的业务情况，对于今后在做自来水公司的项目，打下坚实的基础。

四、          时间控制问题

     编写工作前期，只顾自己编写文档，用了一个多月时间将所有文档都编写完毕，这期间可以提高编写
速度，但是有些模块没有得到客户的确认，耽误了部分时间，后期用了将近半个多月的时间对接，对接
两轮才最终确认，由于客户的时间非常难以掌控，所以后期对接也是有一部分时间浪费掉了。如果前期
编写一个对接一个，或者编写一部分对接一部分，这样速度可能会大大提升。因为这个时间占用少，只
要客户有时间我们就可以对接。得到确认后，这个模块就不用再关注了。因为后期两轮对接下来，功能
页面修改和文档修改的工作量也是很大的。如果还有下次，下次可以根据实际情况来确定是统一对接还
是部分对接。

五、        人际关系

与客户建立良好的人际关系，对于项目的开展是很有帮助的。功能页面设计时，都是站在客户立场上。
在项目经理的带领下，每天工作时间都是从早上9点多到晚上11点左右，每天工作时间大约在15到16个
小时。在短短几个月内，将客户的所有模块功能页面都编写出来，页面总数达到300多个。对接过程中
大的改动很少，都是小的改动，如报表中增加个字段，增加个查询条件，对报表增加合计功能，添加一
个按钮或添加些新的功能页面之类的小改动。客户对我们公司员工的工作给予了高度的评价。在对接的
时候，客户高书记说：“你们越来越像自来水公司的人了”。说明我们公司人员已经充分了解自来水公
司的业务。在编写文档期间，应客户的邀请，经项目经理批准。我带领团队人员参加了自来水公司和移
动公司的联谊会，大家与自来水公司人员玩的非常开心，拉近了与客户不同部门人员的关系。

六、        工作环境

    我以前做过的项目也很多，但是还是第一次遇到这样的工作环境，在这样的工作环境中，没有时间去
偷懒，大家都在努力的工作，如果你去偷懒，感觉有些不好意思。当初来到这里时，感觉太累了，一天
要坐15、16个小时，腰酸背痛，非常难受，就一个想法，赶紧编写完回杭州。后来习惯了，感觉很好，
看到自己的文档一个一个被别人认可，很有成就感。这次让我充分感受到工作的快乐。谢谢领导给我这
次体验的机会。