【软件工程】之关于文档

文档的编写，是学习软件的人必须要经过的一个阶段。但是一开始着手写文档真心的不知道些什么，所以就先把自己会写的写上，然后就去找师父给我挑毛病去了。这一挑可不得了了，让我明白了原来这个文档是这个样子的啊！是干这个用的啊！

首先，这个文档不是按照文档样本把每个文档都写上就算完了，它是有取舍的，我们不能“眉毛胡子一把抓”。写文档主要就是写需求说明书，概要设计说明书和详细设计说明书、数据库设计、用户手册。并且明白每个文档都是给谁看的，主要是按照哪个文档来执行下一步的操作。说白了就是这个文档就是你设计一个软件的指导手册。

下面先说一下我经过师父的指导后的理解吧！

对于需求说明书：要明白什么是需求分析？我理解的需求分析就是分析用户的需求，把用户“要做什么”这个要求转换成为一个软件逻辑模型。所以在这个需求说明书里对于功能的描述越详细越好。这个文档里需要画一个原型图和ER图以及IPO图。

对于概要设计说明书：概要设计就是将软件需求转化为数据结构和软件的系统结构。所以在这个文档里面你要把这个软件的界面的初步模型制造出来，让用户知道这个软件的初步模型是什么样的。还要把系统的架构和所用的模块名，数据库的表名等都设计出来并且明确的写到文档里。（在这里插一句我自己的理解：文档中所谓的方法就是指软件的内部接口，也就是你用到的代码段或者函数什么的）

对于详细设计说明书：详细设计就是通过对结构表示进行细化,得到软件的详细的数据结构、算法和一部分的代码。在这个文档中我们要做的就是更详细的描述这个软件的每个功能。要画一个时序图（在视频中有提到）。要把写代码时候的统一的注释规范写到这里，还要规范窗体的命名规范。

对于数据库设计说明书：在这个文档中要把数据库设计所用到的库，字段，和字段用到的数据类型都写清楚。还要画一个关于如何设计的这个数据库所用到的ER图。

对于用户操作手册：要把怎么安装这个软件，怎么使用这个软件都一步步的写下来。还要把它涉及到的外接机器的操作也都写明白。比如：机房收费要用到读卡器和打印机，怎么操作这两者都应该写清楚。

最后总结一下：这个文档真的要画很多的图，而且画图的时候真心不知道怎么画，但是通过琢磨怎么花这个图让我又从另一个角度了解了我做的机房收费系统。让我的心中渐渐的明白了：哦~~原来这个机房是这么做出来的！我想这应该就是写文档最大的收获吧！因为前几天都忙着自考，就没有把师父给我说的错误总结下来，也没有修改我的文档内容。今天把错误都总结下来，接下来几天就该为我文档的书写走向专业化而努力了！加油！新的挑战开始了！