软件开发文档总结

背景：

        写软件文档将近两个星期，叙述一下我的心理历程：从一开始的茫然到写着写着，结合完成不久的机房收费系统，对于文档的理解渐渐清晰起来，到最后的不断改进，师傅验收这一软件文档项目基本完成，我对于写文档这件事情似乎没有那么恐惧，就像米老师说的那样，教育的过程就是在不断地试错，我们有一个宽松包容的环境允许我们犯错，跌跌撞撞中前进，但每一次跌倒之后的爬起的信念会更加坚定，离远方就更近一点。

 详述：

        软件工程的文档是根据软件的生存周期产生的，从软件的产生到软件的报废这一过程中，不仅需要系统程序的运行使用，还要有软件开发文档的密切指导，为软件生存周期的运转提供前进和完善的方向，都说软件工程是软件开发的灵魂，那么软件工程中的开发文档便是灵魂思想的指引者，软件危机的产生很重要的原因是缺乏一整套完整的开发文档，根据我个人的理解，开发文档对于软件来说是软件前进的道路，如果软件开发缺少了文档的指引，那么软件即使开发出来也是漫无方向的原地踏步，对于软件开发的工程化道路一定要要把软件开发文档的编写重视起来。

 文档区分：

       用户手册和操作手册

      相同点：二者都是面向系统使用的用户的文档资料，为用户服务，让系统的新用户使用，提供一份资料使用户快速入手使用已实现所要求的功能。

      不同点：用户手册其实包括操作手册，软件视为用户服务的，手册自然也是，操作手册更偏重于系统的初始化安装，如何操作系统的页面使用户通过一步步的引导实现软件的安装运行等问题，比较通俗的同义词就是傻瓜手册，面向的用户比如以运营销售软件为生的用户等，因为他们要把软件卖给最单纯使用软件功能的用户，他们要先了解并掌握一定的配置及安装等一系列还没有涉及到软件真正的功能这方面的知识和信息，通过有图有字的一步步原型系统的引导，可以完成新系统的安装配置等问题。

    关于操作手册，  可以参照下图的例子：

    

      而用户手册则面向最单纯直接的以使用软件功能为目的的用户，注重的是用户的需求问题，比如用户要完成某个需求，以qq中的查找好友为例，用户手册就要在以用户的需求为前提下提供可行便捷的指导，详见下图：

      是对软件所有功能的使用说明，满足用户的基本需求，通过用户手册的指导帮助用户完成软件功能的实现，达到用户想要的结果，比如查找到了某一位好友，让用户满意。

我的收获

        通过编写文档，感觉自己技术上关于文档的深入认识仅仅是一小部分，更重要的是思想和学习方法方面的收获。

      1. 留心发现，注重细节

           大家应该都注意到文档的命名都是统一规范的，GB8567-——88，这个是软件设计文档国家标准的说明，自己编写的文档命名时就没有这样的认识，想想我们的条例，每一个命名都很完整规范，不同的人编有不同的文档，如果每个名字都按照自己的喜好来，那就乱套了，该认真的时候认真，粗中有细，留心生活。

      2.  时间管理

          一直爱拖延，上周因为回家又把项目时间后延了一星期，看起来每次都在电脑前坐着，但是学习之后发现自己确实是没干什么实事，指定的计划被打乱，导致学习效率不高，写文档的时候我给自己制定了相对宽松的计划，安排的任务少一些，也就没有那么爱玩和厌烦，根据自己的学习特点制定合适的计划很重要。

      3. 多与人交流

         刚开始的时候手足无措，不知道如何写文档，后来就跟身边的同学一起讨论，发现我们的想法有同有异，我的理解，他的理解，大家的看法，慢慢的，对一个文档就有了多方面的认识，写的时候思路也就开阔一些，自己的思维是狭窄的，多向别人学习，多找自己不足。