合作版机房收费系统—文档

         通过合作机房收费系统，让我对文档有了很不同往前的认识。之前我总以为文档不过是一种书面形式，就好比高中时我们给老师写的请假条一样。通过合作机房收费系统，真的颠覆了以往的看法。而且从我们开始接触文档、写文档到现在，大概也写了挺多遍了，可是合作时我发现我并没有印象中对文档有那么明确而清晰的认识，至少没有明确到那种程度—每个文档里写什么、侧重点是什么、具体放什么图，应该包含哪些内容等等。只是有一个模糊而清晰的概括，但是真的让我说出个一二三来，又觉得自己说不出来。而且今天看了图书馆维护系统的验收，验收的过程中大家对文档中的一些点进行了讨论，让我也长了很多见识。

 

         我们也来碎碎念一下文档的知识，可能你之前懂得，也可能你之前对某个知识点的认识存在误区，或者我的一些观点还存在着问题，都没关系，希望大家各抒己见，发表自己的看法。

 

         我首先说需求文档：这个需求文档要干的事就是要弄明白我们要开发的软件要做什么事，并且对我们要干的事情进行详细的分析，细化到具体每个点，比如一个文本框要输入什么样的字符，是中文、英文？允不允许为空？限制输入长度吗？等等诸如此类，因为我们要细化到让开发人员一目了然，把自己当成开发人员，是不是我一拿到这份需求文档我就把整个系统的需求看得很明白而且还不用跟写文档的人沟通。需求文档是开发人员和客户进行研究沟通的凭证，在这个过程中开发人员不断的完善需求，细化需求，让客户满意，让开发人员能够明白需求，这是需求文档的意义所在。记住哦，需求文档是在系统开发的前期要做的事情，而且需求文档要写的特别详细。

 

         其次，我们来说一下数据库设计。有的文档会给数据库设计单独一个文档，有的数据库设计是依附在详细设计文档中的。数据库设计的规范什么三范式等等我们就不说了，我想强调一点的是数据库设计要加表与表之间的关系图，让开发人员能明白表与表存在的联系和对应关系，说白了也是为了能让开发人员看明白，所以表之间的联系是数据库设计文档中不可缺少的一部分。

 

         下一个来说一下概要设计，其实对概要设计的理解并没有多深，以为是详细设计的外化，就像详细设计就好比语文当中的“详写”，概要设计就相当于语文当中的“略写”一样。其实不然，概要设计在我现在看来是以一个宏观的角度来审视整个系统，并不是仅仅“略写”就可以办到的，它可能没有涉及到具体怎么细化实现这样那样的功能，但是它能大致提供一个系统的轮廓，所以“包图”是概要设计中不可缺少的。

 

         最后说一下详细设计，详细设计当然啦，就必须细化啦，类图、用例图、时序图、包图都是必不可少的。而且在详细设计中要细分各个功能具体是如何实现的，具体的去剖析、去分解，在具体每个功能下面要跟着类图、时序图、对数据结构的声明（表），也就是具体用到了几张表等。相当于详细设计把整个系统的细节都罗列了出来，一般开发人员具体就是参照详细设计来开发软件的。所以，亲们，详细设计要认真写哦。

 

         最后我还想说两句用户手册，这个用户手册在我看来就好比产品介绍说明书，是告诉用户具体怎么操作软件的，所以用户手册是给用户看的。但是今天大家讨论的时候说了一句话用以区分用户手册和需求文档，我觉得很经典。大家讨论说用户手册和需求文档看似有很多相同的地方，甚至精确到输入什么样的东西，具体怎么操作，但是需求文档和用户手册的写作时间是不同的。需求文档放在系统开发前期，而用户手册呢是整个系统开发完而介绍怎么用系统去写的，所以就这点而言二者的区别是很大的。

 

对文档的学习还在继续，觉得现阶段对文档的认识还不是很深刻。随着学习的深入我会不断更正、完善这些观点，也希望大家把文档那足够重视起来。