文档是影响软件可维护性的决定因素。由于长期使用的大型软件系统在使用过程中必然会经受多次修改,所以文档比程序代码更重要。
软件文档应该满足下述要求:
软件文档应该满足下述要求:
(1) 必须描述如何使用这个系统,没有这种描述时即使是最简单的系统也无法使用。
(2) 必须描述怎样安装和管理这个系统。
(3) 必须描述系统需求和设计。(4) 必须描述系统的实现和测试,以便使系统成为可维护的。
文档可以分为用户文档和系统文档两类。
1.用户文档
用户文档是用户了解系统的第一步,它应该能使用户获得对系统的准确的初步印象。
(1) 功能描述
(2) 安装文档
(3) 使用手册
(4) 参考手册(要完整)
(5) 操作员指南(如果需要有系统操作员的话)
2.系统文档
所谓系统文档指从问题定义、需求说明到验收测试计划这样一系列和系统实现有关的文档。描述系统设计、实现和测试的文档对于理解程序和维护程序来说是极端重要的。
和用户文档类似,系统文档的结构也应该能把读者从对系统概貌的了解,引导到对系统每个方面每个特点的更形式化更具体的认识