工作总结

CRM文档整理工作总结

 

2004年11月下旬，我接到部门经理的通知，暂时停下手中的工作去做crm文档整理的工作。做文档对于我来说还是第一次，所以开始感到很新鲜。尽管在网上也听过别人说写文档是很麻烦的一件事，大多数程序员不愿意写文档，但是我还是想利用这个机会尝试一下，我想总能学到一些东西的，况且写文档在以后的工作中总是免不了的。

我和曹璐、熊克斐3个人在钱海源的带领下开始文档整理工作，我比他们两个晚一个星期参与的。钱海源给我们讲了这次工作的主要任务和目的:

1、本次文档整理以“需求分析”为重点，体现一部分设计成分，目的是提供一份能清晰、准确描述eGOTOPsCRM的需求，客户和领导都能看的明白的，并且和开发工具基本无关的文档，这个文档对后续的开发计划能提供业务指导意义。

2、本次需求分析文档以面向对象的设计思路来进行，表形形式为用例图、用例描述、以及可能作为补充的类图、状态图、活动图等。

3、本次需求分析文档整理的方法为：由钱海源负责提交需求整理的模块清单、整理标准及样例以及工作量和建议的人员安排，经部门讨论通过后，安排相关人员编写，编写的过程中钱海源进行指导和检查，并安排相互阅读评议，力图达到让全部参与的人员都能理解该需求文档的全部模块。

同时他还给了我一些参考资料和文档模板，并详细讲解了该怎样学习和做文档。按照要求和安排，首先做的是“需求分析”部分，这部分的主要任务就是用用例来描述系统的需求(参照RUP)，文档的内容也就是用例图和用例描述。

在这次任务中我被分了4个模块以及和熊克斐合做的3个模块，相对他们要少一些。接下来的3个星期就是一边根据软件需求找用例，一边学习UML画用例图，每做完一个模块就先提交给钱海源检查提出意见，之后在钱海源的组织下通过开小组会议点评，我们3个人互相提意见以及讲评各自做的任务，讨论一致通过。这样做的目的也是要求我们3个人都能理解需求文档的全部模块，最后把各自做的模块提交给曹璐合并生产最终需求文档。由于对CRM业务流程不熟悉和对“需求分析“的理解不够，在这个过程中我碰到了不少问题，给我印象最深的有3个问题：

第一.角色一时转变不过来，我们写的文档是为开发人员与客户能够更好的交流，所以要站在用户的角度看需求，并且文档不能用太专业的词汇，这样用户是很难理解的，如果做不到这一点就很能把握主要问题和次要问题，也就很难准确的找出用例。

第二.由于我们是先有软件后来写文档的，这样以来在找用例的时候往往被软件本身界面所束缚，抓不住问题的关键。

第三.UML的应用，画用例图要用UML，UML的知识没有掌握好，运用起来就常常出错，比如在表述用例关系的时候有3种：包含、扩展、泛化，这是容易混淆的。

问题是不断的出现了，不过在钱海源的细心指导和耐心讲解下这些问题都得到了解决，从这个过程中学到了很多，我想至少在以后同样的工作中可以尽量避免少出现类似的问题。

“需求分析”部分做完了，接下来就是“业务类”部分，这部分主要是找出系统中各个模块所用到的类(这里只对实体类)以及类的描述(包括属性、方法、类与类直接的关系)，对于有些复杂的类要附以状态图或活动图加以描述。在这部分我做的任务相对要比他们多一些，不过这次要简单一些，只是按照软件的界面找出实体类，技术性的东西不多，主要是类的属性的类型要注意一下，再就是类之间的关系，以及画模块的总类图。这一次是我合并所有类图，再用Rational SoDA生产文档，在这个过程中碰到了一些麻烦，以前也是没有用过Rational SoDA这个工具，模板事先也没有仔细检查，做的不好，所以把整个系统的类放在一起生成的时候非常慢，最后生成的文档图也没有显示出来，也没有类的说明，只好自己手动一个个添加，花了很长时间才整理好。由于在生成文档的时候出现了一些错误，浪费了不少时间，为了按计划提交，不得不加了几次班。

第三部分是“数据表”，这部分任务就很少了，也非常简单，就是从数据库中导出表，对一些字段加以说明。我和熊克斐两个人只用了2天的时间就完成了，最后由熊克斐合并提交的。

在做文档整理这个工作的过程中，公司组织了软件开发培训，内容是关于UML及其应用、RUP、设计模式，其中UML及其应用部分正好和我们这次做文档整理有关，通过具体的实践更深入的掌握了UML，RUP部分让我们认识到软件开发过程中“需求分析“的地位，从而更加肯定了这段时间来所做的工作的收获。

一个半月的工作在紧张而有序中很快就结束了，我们如期的完成了任务。在这短短的45天左右的时间里，不但对CRM的业务流程有了进一步的了解（做这项工作的主要目的），而且我感觉学到了很多其他东西，也改变的一些错误或者说是不好的看法。

1．  写文档确实很枯燥，但也确实很重要。

2．  再一次感受到软件开发过程中团队的重要性，软件开发的每一个步骤不是那一个人完成得了的，合作、沟通尤为重要。

3．  通过实践和参加培训，更进一步理解了面向对象的软件设计的思想，初步了解了软件开发过程中最重要的一个流程——需求分析。

4．  改变了程序员只是写程序这一错误的认识，从RUP讲述中知道，写程序只是软件开发4个阶段中的一个，写程序的工作量也只是占了整个开发工作量的一半左右。

   除了以上的这些收获，通过这次工作和学习，学会了怎样去写文档，其中RUP中给出了很多类型文档的模板，学会了使用建模工具Rational Rose、Rational SoDA，学习了RUP和UML，这些都是非常有用的。

      总之，这次小插曲式的工作给了我一份意外的大收获，不管是在知识和技术层面上，还是在认识工作上，都有了很多的提高。

最后要感谢这段时间带领我们工作的钱海源，正是在他的指导下才得以顺利的完成了这次任务并学到了这么多的东西，从另一个方面也可以说，是他教我学到了这些东西，他不厌其烦的指导我们，给我们讲解，有时一个问题要改上3、4次才能通过。他的知识面宽广，经验丰富，技术好，是我学习的榜样。感谢在一起做这项工作的熊克斐和曹璐，给了我帮助。

通过这次工作和学习，我会在以后的工作中不断的学习，掌握更多的技术，认认真真的工作，为公司的发展作出自己最大的贡献。