软件文档的定义

软件 = 程序+文档+数据。
文档是某种数据媒体和其中所记录的数据。

软件文档的特点

文档具有永久性，可供人阅读。
文档是计算机软件的重要组成部分

软件的生存周期

  • 从构思软件开始到该产品不再使用为止的时间段
  • 分为计划、开发、运行三个时期。不同实践不同角色参与其中。
  • 计划时期：
    • 问题分析
    • 可行性研究
    • 制定计划
  • 开发时期
    • 需求分析
    • 概要设计
    • 详细设计
    • 编码测试
    • 软件发布
  • 运行维护时期
    • 运行维护

软件文档的作用

管理的依据
技术交流的语言
软件质量的保证
支持培训与参考
支持软件维护
记录软件的历史

软件文档的分类

  • 使用范围：
    • 管理类文档，记录项目管理的信息
    • 开发类文档，描述软件开发过程本身
    • 产品类文档，描述开发过程的产物
  • 阅读对象：
    • 管理人员
    • 开发人员
    • 维护人员
    • 最终用户
  • 软件开发方法
    • 面向过成的文档
    • 面向对象的文档

软件工程文档标准化的意义

  • 提高软件的可靠性、可维护性和可移植性
  • 提高软件的生产率和软件人员的技术水平
  • 提高软件人员之间的通信效率，减少差错和误解
  • 有利于软件管理
  • 有利于降低软件产品的成本和运行维护成本
  • 有利于缩短软件开发周期

软件工程文档标准的层次：

国际标准
国家标准
行业标准
企业规范
项目规范

常见的软件文档类型