文档

文档是影响软件可维护性的决定因素。由于长期使用的大型软件系统在使用过程中必然会经受多次修改,所以文档比程序代码更重要。
软件文档应该满足下述要求:

(1) 必须描述如何使用这个系统,没有这种描述时即使是最简单的系统也无法使用。

(2) 必须描述怎样安装和管理这个系统。

(3) 必须描述系统需求和设计。

(4) 必须描述系统的实现和测试,以便使系统成为可维护的。

文档可以分为用户文档和系统文档两类。

1.用户文档

用户文档是用户了解系统的第一步,它应该能使用户获得对系统的准确的初步印象。
 (1) 功能描述
 (2) 安装文档
 (3) 使用手册
 (4) 参考手册(要完整)
 (5) 操作员指南(如果需要有系统操作员的话)

2.系统文档

       所谓系统文档指从问题定义、需求说明到验收测试计划这样一系列和系统实现有关的文档描述系统设计、实现和测试的文档对于理解程序和维护程序来说是极端重要的。

       和用户文档类似,系统文档的结构也应该能把读者从对系统概貌的了解,引导到对系统每个方面每个特点的更形式化更具体的认识

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

斜阳雨陌

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值