1、软件文档一般分为三类:开发文档、产品文档、管理文档。
1)开发文档描述开发过程本身,基本的开发文档包括:
(1)可行性研究报告和项目任务书
(2)需求规格说明
(3)功能规格说明
(4)设计规格说明,包括程序和数据规格说明
(5)开发计划
(6)软件集成和测试计划
(7)质量保证计划
(8)安全和测试信息
2)产品文档描述开发过程的产物,基本的产品文档包括:
(1)培训手册
(2)参考手册和用户指南
(3)软件支持手册
(4)产品手册和信息广告
3)管理文档记录项目信息管理的信息,例如:
(1)开发过程的每个阶段的进度和进度变更的记录。
(2)软件变更情况的记录
(3)开发团队的职责定义
(4)项目计划、项目阶段报告。
(5)配置管理计划
2、文档的质量可以分为四级:
最低限度文档(1 级文档),适合开发工作量低于一个人月的开发者自用程序。该文档应包
含程序清单、开发记录、测试数据和程序简介。
内部文档(2 级文档),可用于没有与其他用户共享资源的专用程序。除1 级文档提供的信息外,2 级文档还包括程序清单内足够的注释以帮助用户安装和使用程序。
工作文档(3 级文档),适合于由同一单位内若干人联合开发的程序,或被其他单位使用的程序。
正式文档