信息系统的文档管理

（2）按照信息系统生命周期的阶段不同，可 以划分为：系统规划阶段文档，如系统可行性 研究报告、项目开发计划书等；系统分析阶段 的文档，如系统分析说明书等；系统设计阶段 的文档，如系统设计说明书、需求变更申请书 等；系统实现阶段的文档，如程序设计报告、 系统测试报告、开发总结报告等；系统运行与 维护阶段的文档，如用户手册、操作手册与维 护修改建议书等。 本书的附录——国家标准《计算机软件产 品开发文件编制指南》基本上是按照软件的生 命周期进行讲解的，可以作为信息系统文档的 参照。
一、信息系统文档的作用与类型
在软件工程的学科领域里，文档和程序加 在一起被合称为软件。文档与程序的区别在于 前者是人可读的，后者主要是机器用来执行的。 如果将源程序加上注释，也可称为文档的一部 分。 本节主要介绍： l、 信息系统文档的作用 2、信息系统文档的类型
l、信息系统文档的作用

尽管文档的重要性大家都大体知道，但在实际 工作中，文档在编制和使用中仍然存在着许多问题， 有待于解决。系统开发人员中较普遍地存在着对编 制文档不感兴趣的现象。从用户方面看，他们又常 常抱怨：文档售价太高、文档不够完整、文档编写 得不好、文档已经陈旧或是文档太多，难以使用， 等等。各类文档究竟应该写哪些内容，说明什么问 题，下面将大体按照信息系统生命周期的阶段，逐 一介绍上面提到的各种文档。由于信息系统的分析 与设计在信息系统的建设过程中非常重要，所以在 对所有文档分别进行简单介绍后，专门给出了系统 分析说明书和系统分析说明书的内容与参考格式。
文档在系统开 用户 发人员、项目管理 开发人员 人员、系统维护人 员、系统评价人员 前期开发人员 以及用户之间的多 开发人员 种桥梁作用可从图 开发人员 8-1中看出。图8-1中 列出了文档在信息 开发人员 系统建设和运行过 用户 程中的七种典型沟 通作用：
系统开发人员
文
项目管理人员 后期开发人员 测试人员 用户

这里指的信息系统的文档，不但包括应用软件开 发过程中产生的文档，还包括硬件采购和网络设计中 形成的文档；不但包括上述有一定格式要求的规范文 档，也包括系统建设过程中的各种来往文件、会议纪 要、会计单据等资料形成的不规范文档，后者是建设 各方谈判甚至索赔的重要依据。显然，文档的含义在 信息系统学科领域里比软件工程学科宽泛。 所以文档是软件的一部分，更是信息系统的一部 分。没有文档的软件，不称其为合格的软件；没有文 档的信息系统，不称其为完整的信息系统。

（3）按照文档不同的服务目的，可以将信息 系统的文档分为三类：用户文档、开发文档与 管理文档。用户文档主要是为用户服务的，开 发文档主要是为开发人员服务的，管理文档主 要是为项目管理人员服务 的。上述三种文档 的内容参见图8-2。 当然，图中的分类不是绝对的，比如项 目开发计划对于开发人员来讲很重要；测试计 划和测试报告对于管理人员来讲也很重要。这 里要强调项目管理文档的重要性。项目管理文 档是对项目计划、费用和问题进行监督的管理 手段和项目建设过程进行记录的工具。这能使 各级管理部门对项目的进展保持预见性，以便 能及时发现和处理系统开发及维护过程中出现 的问题。


（6）系统开发人员与系统维护人员通过文档进行沟通。
（7）用户与维护人员在运行维护期间进行沟通。 上述七个方面是文档在沟通方面的主要作用，其实，文 档还可以作为监理和审计的对象，作为开发其他信息系统的 参照。
如果发生合同纠纷，文档还能体现出证据 的作用。因为每份文档都是项目建设中有关成 员的一种书面承诺。绝大多数文档都是需要签 名的。而签名就表示对自己所签署的那部分文 档内容的认可和承担责任。特别是用户提出的 需求变更申请书必须妥善保管，这些文件在发 生纠纷时往往能成为保护自己甚至索赔的重要 依据。 显然，文档的编制在信息系统的开发工作 中占有突出的地位和相当的工作量。高效率、 高质量地写作、分发、管理和维护文档对于充 分发挥信息系统的效益有着重要意义。

2、信息系统文档的类型

信息系统的文档有许多种分类方法： （1）按照产生频率分为一次性文档和非一次性文档。 前者如系统分析说明书、系统设计说明书等，后者 如开发过程中用户提交的需求变更申请书。非一次 性文档还可以分为频率固定文档和频率不固定文档， 频率固定文档有项目组月度开发报告、信息系统运 行日志、运行月报等，频率不固定文档有会计单据、 需求变更申请书、维护修改建议书等。 一次性文档和频率固定的文档一般都有较固定 的内容和格式，而频率不固定的文档由于发生的随 机性，导致文档记录人员在撰写文档时的随意性。 为了管理好这些频率不固定的文档，需要对这些文 档予以编号，并尽可能地统一格式，以便做到规范 管理。
档
维护人员
维护人员
图8-1 信息系统文档的沟通作用图

（1）用户与系统分析人员在系统规划和系统分析阶段通过 文档进行沟通。
（2）人员与项目管理人员通过文档在项目期内进行沟通。

Baidu Nhomakorabea（3）前期开发人员与后期开发人员通过书面文档进行沟通。
（4）系统测试人员与系统开发人员通过文档进行沟通。 （5）系统开发人员与用户在系统运行期间进行沟通。

用户文档
信息系统 的文档
开发文档
管理文档
用户手册 操作手册 运行日志/月报 维护修改建议书 系统分析说明 系统设计说明 程序设计说明 测试计划 测试报告 可行性研究报告 项目开发计划 需求变更申请书 开发进度月报 开发总结报告
图8-2 按照服务目的不同划分的文档类型
二、信息系统各类文档的内容

信息系统的文档，是系统建设过程的“痕迹”，是 系统维护人员的指南，是开发人员与用户交流的工具。 规范的文档意味着系统是按照工程化开发的，意味着信 息系统的质量有了形式上的保障。文档的欠缺、文档的 随意性和文档的不规范，极有可能导致原来的开发人员 流动以后，系统不可以维护、不可以升级，变成一个没 有扩展性、没有生命力的系统。所以，为了建立一个良 好的信息系统，不仅要充分利用各种现代化信息技术和 正确的系统开发方法，同时还要做好文档的管理工作。 本节主要讨论的内容： 一、信息系统文档的作用与类型 二、信息系统各类文档的内容 三、信息系统文档的编制与管理