信息系统的文档管理

《信息系统的文档管理》由会员分享，可在线阅读，更多相关《信息系统的文档管理（58页珍藏版）》请在金锄头文库上搜索。

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

2、领域里，文档和程序加 在一起被合称为软件。文档与程序的区别在于 前者是人可读的，后者主要是机器用来执行的 。如果将源程序加上注释，也可称为文档的一 部分。本节主要介绍：vl、 信息系统文档的作用v2、信息系统文档的类型 l、信息系统文档的作用v 这里指的信息系统的文档，不但包括应用软件开 发过程中产生的文档，还包括硬件采购和网络设计中 形成的文档；不但包括上述有一定格式要求的规范文 档，也包括系统建设过程中的各种来往文件、会议纪 要、会计单据等资料形成的不规范文档，后者是建设 各方谈判甚至索赔的重要依据。显然，文档的含义在 信息系统学科领域里比软件工程学科宽泛。v 所以文档是软件的一部分，更是

3、信息系统的一部 分。没有文档的软件，不称其为合格的软件；没有文 档的信息系统，不称其为完整的信息系统。文档在系统开发 人员、项目管理人员 、系统维护人员、系 统评价人员以及用户 之间的多种桥梁作用 可从图 8-1中看出。图8-1中 列出了文档在信息系 统建设和运行过程中 的七种典型沟通作用 ：文档用户开发人员前期开发人员开发人员开发人员开发人员用户系统开发人员项目管理人员后期开发人员测试人员用户维护人员维护人员图8-1 信息系统文档的沟通作用图v（1）用户与系统分析人员在系统规划和系统分析阶段通过文 档进行沟通。 v（2）人员与项目管理人员通过文档在项目期内进行沟通。 v（3）前期开发人员与后

4、期开发人员通过书面文档进行沟通。 v（4）系统测试人员与系统开发人员通过文档进行沟通。 v（5）系统开发人员与用户在系统运行期间进行沟通。 v（6）系统开发人员与系统维护人员通过文档进行沟通。 v（7）用户与维护人员在运行维护期间进行沟通。 上述七个方面是文档在沟通方面的主要作用，其实，文 档还可以作为监理和审计的对象，作为开发其他信息系统的 参照。 v 如果发生合同纠纷，文档还能体现出证据的 作用。因为每份文档都是项目建设中有关成员的 一种书面承诺。绝大多数文档都是需要签名的。 而签名就表示对自己所签署的那部分文档内容的 认可和承担责任。特别是用户提出的需求变更申 请书必须妥善保管，这些文件

5、在发生纠纷时往往 能成为保护自己甚至索赔的重要依据。v 显然，文档的编制在信息系统的开发工作中 占有突出的地位和相当的工作量。高效率、高质 量地写作、分发、管理和维护文档对于充分发挥 信息系统的效益有着重要意义。2、信息系统文档的类型 v信息系统的文档有许多种分类方法：v（1）按照产生频率分为一次性文档和非一次性文档 。前者如系统分析说明书、系统设计说明书等，后 者如开发过程中用户提交的需求变更申请书。非一 次性文档还可以分为频率固定文档和频率不固定文 档，频率固定文档有项目组月度开发报告、信息系 统运行日志、运行月报等，频率不固定文档有会计 单据、需求变更申请书、维护修改建议书等。一次性文档

6、和频率固定的文档一般都有较固定 的内容和格式，而频率不固定的文档由于发生的随 机性，导致文档记录人员在撰写文档时的随意性。 为了管理好这些频率不固定的文档，需要对这些文 档予以编号，并尽可能地统一格式，以便做到规范 管理。v（2）按照信息系统生命周期的阶段不同，可 以划分为：系统规划阶段文档，如系统可行性 研究报告、项目开发计划书等；系统分析阶段 的文档，如系统分析说明书等；系统设计阶段 的文档，如系统设计说明书、需求变更申请书 等；系统实现阶段的文档，如程序设计报告、 系统测试报告、开发总结报告等；系统运行与 维护阶段的文档，如用户手册、操作手册与维 护修改建议书等。v 本书的附录国家标准计

7、算机软件产 品开发文件编制指南基本上是按照软件的生 命周期进行讲解的，可以作为信息系统文档的 参照。v（3）按照文档不同的服务目的，可以将信息 系统的文档分为三类：用户文档、开发文档与 管理文档。用户文档主要是为用户服务的，开 发文档主要是为开发人员服务的，管理文档主 要是为项目管理人员服务 的。上述三种文档 的内容参见图8-2。v 当然，图中的分类不是绝对的，比如项目 开发计划对于开发人员来讲很重要；测试计划 和测试报告对于管理人员来讲也很重要。这里 要强调项目管理文档的重要性。项目管理文档 是对项目计划、费用和问题进行监督的管理手 段和项目建设过程进行记录的工具。这能使各 级管理部门对项目

8、的进展保持预见性，以便能 及时发现和处理系统开发及维护过程中出现的 问题。信息系统 的文档用户文档开发文档管理文档用户手册 操作手册 运行日志/月报 维护修改建议书 系统分析说明 系统设计说明 程序设计说明 测试计划 测试报告 可行性研究报告 项目开发计划 需求变更申请书 开发进度月报 开发总结报告图8-2 按照服务目的不同划分的文档类型二、信息系统各类文档的内容v 尽管文档的重要性大家都大体知道，但在实际 工作中，文档在编制和使用中仍然存在着许多问题， 有待于解决。系统开发人员中较普遍地存在着对编制 文档不感兴趣的现象。从用户方面看，他们又常常抱 怨：文档售价太高、文档不够完整、文档编写得不

9、好 、文档已经陈旧或是文档太多，难以使用，等等。各 类文档究竟应该写哪些内容，说明什么问题，下面将 大体按照信息系统生命周期的阶段，逐一介绍上面提 到的各种文档。由于信息系统的分析与设计在信息系 统的建设过程中非常重要，所以在对所有文档分别进 行简单介绍后，专门给出了系统分析说明书和系统分 析说明书的内容与参考格式。v本节内容:v1、系统各类文档的内容简介v2、系统分析说明书编写指南v3、系统设计说明书内容指南l、系统各类文档的内容简介信息系统建设过程中主要文档有 ：系统开发立项报告、可行性研究报 告、系统开发计划书、系统分析说明 书、系统设计说明书、程序设计报告 、系统测试计划与测试报告、系

10、统使 用与维护手册、系统评价报告、系统 开发月报与系统开发总结报告。下面 对它们逐一介绍 ：（1）系统开发立项报告 在信息系统的正式开发前。用户单位必须提出要开 发的新系统的目标、功能、费用、时间、对组织机构的 影响等。如果是本单位独立开发或联合开发，这些内容 形成的文档称做立项报告，用于向领导申请经费及支持 等；如果是委托开发，则以任务委托或开发协议(合同) 方式进行说明。立项报告主要包括以下内容：v概述：概述现行系统的组织结构、功能、业务流程以 及存在的主要问题。v新系统的目标：开发新系统的意义和新系统实现后的 功能、技术指标、安全和保密性、新系统运行环境等。v经费预算和经费来源。 v项目

11、进度和完成期限。v验收标准和方法。 v移交的文档资料。v开始可行性研究的组织队伍、机构与预算。 v其他有关需要说明的问题。 （2）可行性研究报告可行性研究阶段的文档是可行性研究报告。在可行 性研究报告中要说明待开发项目在技术上、经济上和社 会因素上的可行性，评述为了合理地达到开发目标可供 选择的各种可能实施的方案，说明并论证所选定实施方 案的理由。可行性研究报告主要包括以下内容：v 概述。v 新系统的目标、要求和约束。 v 可行性研究的基本准则。 v 现行系统描述及现行系统存在的主要问题。v 新系统对现行系统的影响。 v 投资和效益分析。v 其他可选方案及与国内外同类方案的比较。v 有关建议。

12、 （3）系统开发计划书 可行性报告被批准后及在系统开发之前，需要拟定一 份较为详细的系统开发计划，以保证系统开发工作按计划 保质保量按时完成。在开始计划书中，应该说明各任务的 负责人员、开发的进度、开发经费的预算、所需的硬什及 软件资源等。开发计划书应提供给项目管理人员，作为开 发阶段评审的参考。对于项目计划的管理，可以采用 Microsoft Project等项目管理软件进行辅助管理。系统开 发计划书的主要内容如下： v 概述：主要包括系统开发的主要目标、基本方针、参加 人员、工作阶段和内容等。v 开发计划：系统开发各工作阶段或子项目的任务、分工 、负责人、计划时间(开始及结束时间)、人力与

13、资金及设备 消耗、实际执行情况等。可用工作进度表、甘特图、网络 图及关键路径法等工具辅助管理。v 验收标准：每项工作完成后验收的标准(时间、资金、质 量等)。v 协调方法：信息系统开发中各个单位、阶段之间的衔接 、协调的方法、负责人、权限等。（4）系统分析说明书当信息系统的开发采用委托方式进行开发时，用户需 求说明书(或叫用户需求报告)是开发单位与用户间交流的 桥梁，同时也是系统设计的基础和依据。当采用独立开发 或合作开发时，系统分析是系统开发中最重要的工作，其 工作成果就是系统分析说明书(或叫系统分析报告)。系统 分析工作的好坏决定了新系统的成败。从信息系统生命周 期的角度来看，用户需求说明

14、书就是系统分析说明书。系 统分析说明书的主要内容一般包括：v 概述。v 系统需求。 v 新系统目标与新系统的功能。v 新系统的逻辑模型。v 新系统的运行环境。v 新系统的验收标准与培训计划。（5）系统设计说明书在系统分析的基础上，根据系统分析说明 书进行新系统的物理设计，并完成系统设计说明 书(或叫系统设计报告)的撰写。系统设计说明书 主要包括以下内容：v 概述。 输入与输出设计。v 总体结构。 计算机处理过程设计。v 计算机系统配置。 接口及通信环境设计。v 代码设计。 安全和保密设计。v 数据库设计。 数据准备。（6）程序设计报告依据系统设计报告，进行程序设计工作。 程序设计经调试通过后，

15、应完成程序设计报告， 以便为系统调试和系统维护工作提供依据。有了 程序设计报告，就可以避免因程序员的流动造成 系统维护工作的困难。程序设计报告的主要内容 如下：v 概述。 程序流程图。v 程序结构图。 源程序。v 程序控制图。 程序注释说明。v 算法。（7）系统测试计划与测试报告为做好组装测试和确认测试，需为如何组织测试制定实 施计划。测试计划应包括测试的内容、进度、条件、人员、 测试用例的选取原则、测试结果允许的偏差范围等。v 测试工作完成以后，应提交测试计划执行情况的说明。对 测试结果加以分析，并提出测试的结论意见。系统测试是系 统实施阶段的重要工作。系统测试报告主要内容如下：v 概述：说

16、明系统测试的目的。v 测试环境：有关软硬件、通信、数据库、人员等情况。v 测试内容：系统、子系统、模块的名称，性能技术指标 等。v 测试方案：测试的方法、测试数据、测试步骤、测试中 故障的解决方案等。v 测试结果：测试的实际情况、结果等。 v 结论：系统功能评价、性能技术指标评价、结论。（8）系统使用与维护手册系统使用与维护手册是为用户准备的文档。有的系统比较大 ，将使用手册与维护手册分开。其中，系统使用手册(或叫操作手 册)一般是面向业务人员的，他们是系统的最终使用者。系统维护 手册(或叫技术手册)是供具有一定信息技术专业知识的系统维护 人员使用的。系统使用与维护手册的主要内容包括：v 概述：主要包括系统功能、系统运行环境(软、硬件)、系统安 装等内容。v 使用说明：系统操作使用说明较为详细地说明了操作的目的、 过程、方式、输入输出的数据等。最好将系统操作的界面图放入 说