软件工程----第一遍机房文档之串思路

前言：

    昨晚顺利的完成了机房收费系统第一遍文档的验收，验收过程中对于各个文档之间的联系、功能、重要性，师傅和我一同做了分析，又经过查阅网上的资料、和身边实习的实习的师哥师姐的交流以及自己的思考，我想把整个文档做个总结，方便在UML以及做以后的系统时文档的编写。

            

           如图是软件工程文档的模板：

       

    总共12个文档，看起来毫无头绪，照着顺序写吧，写完之后仍然一头雾水，可是想要给这12个文档撒一点魔术粉串起来整体做一下把控，就得归归类，排排序了。As illustrated in this picture：

                 

    如图所示，把整个过程12个文档分成5个阶段：准备、计划、设计、测试、总结，文档的撰写我理解总体就是按着这个顺序，其中小的标号为样本文档中文档的顺序，粉色（or紫色）的地方是我认为比较重要的几个阶段，同时此处需要说明：

  （1）图中未画出用户手册和操作手册，因为这两个文档的编写是贯穿在其他文档之间的，就像操作手册，In my opinion，从概要设计阶段就要开始写的，贯穿到文档的结束。So,这一点需要说明。

  （2）编写顺序，样本文档中在《项目开发计划》后才进行《需求说明》，开始我也是这样理解的，但是在昨晚和师傅讨论的时候师傅帮我纠正了一下，就像如果都不知道用户究竟想要干什么，怎么做计划？凭空去想？要知道每个系统的侧重点都是不一样的，侧重不一样，系统开发过程中时间、人员的分配就会不同，so，往往先进行完《需求说明书》后才开始《开发计划》，同时也想参加过实习的师姐请教了，正规点的公司就是这样，小公司往往身兼数职。

  （3）这个图侧重了文档的编写顺序，对于各个文档之间的联系基本上没有表现（画图能力有待提高），主要是自己只写了一次文档，对于文档的理解程度还不高。

   接着简单说明几个文档之间的关系：

   （1）《操作手册》、《用户手册》，在写这两个文档的时候脑子里一头雾水，究竟他们的区别在哪里？开始我的理解，前者注重于系统操作步骤的介绍，后者除了操作步骤，还有系统的性能、功能、运行环境、易出错的地方等的说明，更加详细一点。

     我上网查了一下：“操作手册是系统级别的文档，而用户手册是需求级别的文档。操作手册讲述的是如何操作该系统的某个页面（你可以根据系统的菜单，一个一个的讲述它的操作按钮），而用户手册是在用户想做什么事情，在这样的前提下引导用户去操作该系统完成这样的需求（比如可以写个使用快速入门的小手册，把常规的使用写好：要实现什么功能要怎么操作），在做项目的时候一个操作手册可以代替用户手册，因为各方面的需求很明确。”难怪师傅说这两个文档可以写成一个文档。

  （2）设计阶段的四个文档：把《概要设计》比作骨架、《详细设计》就是往骨架上添血添肉，而《数据库的设计》和《数据要求说明书》就可以比作成不断支持着身体细胞新陈代谢的器官和血管，有了他们，数据便可以在各个模块、功能之间来回调用。

  （3）一旦用户的需求发生了变化，可能仅仅是一个小小功能的添加、修改，便会对其他文档的编写执行造成影响，但是只要是按着上面分的这五个阶段逐次来尽心分析，即使需求变动很大，对于我们做出这个系统的影响也会降到很低。

   All in all,软件工程是为了更高效的进行软件开发，文档则是软件工程思想的一个很好的体现形式，把握好软件工程各个阶段核心思想，文档的撰写就不至于跑偏，软甲的开发才会更加的高效。