软件文档概述（一）

导言：

      软工视频告一段落，即将踏上写文档的末班车，希望这段时间的学习不要那么浮躁，可以踏踏实实地学点知识，理论加上实践，这个美好的11月，期待一个更加进步的自己，在写文档正式开始之前，先来概述一下，大致熟悉文档，再次与它见面就不会陌生了。

 一、  软件文档的概念(what)

          文档是指某种数据媒体和其中所记录的数据，具有永久性，固定不变的格式，具有规范性，可被人和计算机阅读。

          软件文档是记录软件开发活动和阶段性成果、理解软件所必需的阐述性资料，它是一系列信息的载体。

 二、软件文档的目的(why)

        在这个软件盛行的时代，用户的需求复杂多变，为了满足用户的需求，各种各样的软件数量日益增多，但随着软件工作环境（硬件系统或系统软件的升级换代）变化，软件只重视开发而忽略维护，引发了软件危机，软件危机的表现主要是用户需求不满足、软件质量差、成本和进度不准确，可维护性差，文档不完整、不合格等，为了更好地解决软件危机，让软件开发规范化和工程化，软件文档起着举足轻重的作用，所以很有必要重视软件生存周期（计划、开发、运行）软件文档的编写，它是软件开发的关键环节。

       促进对软件的开发、管理和维护

       便于各种人员（用户和开发人员）的交流

 三、软件文档的要求（requirement)

    1.文档的及时性

         在软件生存周期中，每一个阶段都应有明确的文档与之对应，作为一切计划和工作开展的依据和参照，一定要及时更新和完善，确保高质量。

    2.文档的完整性

        任何一个文档都应当是完整的、独立的，它应自成体系。

   3.文档的准确性

       文档的行文应当十分准确，不能出现多义性的描述。统一课题几个文档的内容应当是协调一致，没有矛盾的。

   4.文档的规范性

      文档的编写有着固定的格式，有一个统一的格式标准，可被计算机和人阅读。 

 四、软件文档的分类（classification）

     1.依形式来分：

          一类是开发过程中填写的各种图表，称之为工作表格；

          一类是编制的技术资料或技术管理资料，称之为文档或文件

     2.依文档产生和使用范围：

           开发文档  、管理文档和用户文档

           


         

 五、  软件文档的地位和作用（Status and function）

    1.
文档提高软件开发过程的”透明度“，便于管理人员对整个开发过程进行管理和控制
2. 管理人员可以把开发过程中发生的事件以某种可阅读的形式记录在文档中，这些可以作为检查软件开发进度和开发质量的依据，实现对软件开发的工程管理。
3. 文档反映开发人员在各阶段的工作成果和结束标志。
4. 文档记录从问题定义、需求分析、软件设计到验收测试，这一系列有关软件的的管理信息和技术信息，既便于协调软件开发工作，又为软件维护和扩充提供了依据。
5. 提供对软件的运行、维护和培训的有关信息，便于管理人员、开发人员、操作人员、用户之间的协作、交流和了解，使软件开发活动更科学、更有成效。
6. 提高开发效率。软件文档的编制，使得开发人员对各个阶段的工作都进行周密思考、全盘衡量、减少返工。而且可在开发早期发现错误和不一致性，便于及时加以纠                      正。

总结：     

        从大体上认识了软件文档，感觉软件文档的编写至关重要，我们已经知道了软件文档它的概貌，之前觉得小伙伴验收时的文档写了好多好多，还在担心到时的自己如何渡过，现在觉得它就是纸老虎，那么可怕了，人生不设限，在自己没有真正经历的时候，不要被别人的影子遮住，那未必是你的生活，加油！（用了几个英文单词，不知道是否合适，关于博客问题，请大家多多指教）