软件工程之文档

             经过很长时间的努力，第一次机房收费系统地文档总算是写完了。下面就来说说我的收获吧。

       我们学习新知识，首先要解决的问题是是什么？为什么？怎么做？文档也不例外，我就按照我的理解依次回答这些问题。

       文档是我们开发软件过程中的记录性文件。我们用文档来指导和规范软件的开发过程。整个软件的文档需要由客户和软件开发人员共同完成，需要用到专业知识和工具。

       不同的文档有不同的标准，我用的文档是国家标准GB8567--88文档，这个文档包括15个文件，根据实际情况，我用到了其中的13个。

       接着说说我在写文档时遇到的问题。第一个问题就是，写文档之前并没有搞清楚每个文件的意义是什么。比如写进度开发月报，开发月报的目的是什么？如果没有搞清楚目的，它的预期读者也不清楚写什么。既然叫做开发月报，也就是和进度相关的，站在进度的角度不难理解，它是为用户、项目经理设计的，用户需要知道开发进度以了解交付日期，项目经理需要用它来计算是否能盈利和按时完成。

       第二个问题是没有站在预期读者的角度考虑问题。比如操作手册，需要初始化的步骤截图，因为当时没有站在用户角度考虑问题，就没想到要截图。我们是软件的开发者，对这个系统很熟悉，甚至知道输入什么数据会出现问题，出现问题怎么解决，但是用户不知道啊。举个简单的例子，手机说明书大家都有，上边就有各种操作的具体说明，看着手机说明书来写操作手册就很直观。

       第三个问题，没有考虑实际情况。比如在编写数据库文档时，我们还没有进行数据库设计，文档中要求有数据库物理图，我直接就把数据库截图放进去了。这是个很容易被忽视的问题，数据库没有创建，怎么会有截图呢？

       第四个问题，侥幸心理。在编写测试计划文档时，需要为每个模块编写测试计划和过程，总共二十多个模块，很多，当时就想着省事，只写了一个模块，还想着蒙混过去。这是个很严重的错误，在这可以蒙混，但是真正需要开发软件的时候，就砸着自己脚了（出来混，总是要还的）。

       当然了，有问题，也有收获。首先理解了很多新知识，以前只是了解过数据图、逻辑图、甘特图，书面了解总是不深刻，这次有机会亲自去实现这些图，当然了解理解很深刻。

       对机房收费系统的内部逻辑有了新的认识。当时只顾着敲代码，没有仔细分析其中的逻辑结构。写文档时，需要分析模块功能，把系统仔细的分析了一遍。对系统的逻辑和功能有了新的认识。

       对软件开发过程的认识。做系统，看视频，一直以为软件的开发过程也就那几个步骤。写完文档后，瞬间对这个过程有了不同的见解，这个过程应该从需求开始，一直到新的需求结束。

      以上这些都是目前对文档的认识。随着学习的深入，对软件工程和文档的理解也会更加深刻的。