工程主要文档的编制内容

四、LIS工程主要文档的编制内容

1.立项报告

立项报告是选择建设项目的依据，它必须完全符合LIS建设的要求，具有显著的社会效益和经济效益。

立项报告应包括以下各项内容:

(1)引言。引言包括:①系统简介。简要介绍系统的名称、目标和功能，并说明系统建设的组织单位、服务对象及与其他系统或机构的联系。②参考资料。列出有关文件的作者、标题、编号、发表日期和出版单位，必要时说明这些文件资料的来源。

(2)系统概况。简要说明新系统的建设规模、组织机构和初步的建设实施计划。

(3)系统建设的必要性。主要说明旧系统的弊病和新系统的优越性，以及它所产生的显著的社会效益、经济效益。

(4)系统的投资概算。对系统建设所需的投资进行估算，提出投资概算和初步的资金筹措设想。计划利用外资的项目，需说明利用外资的可能性及偿还贷款能力测算。

(5)附件。附上与文件有关的其他文件、资料。

2.可行性研究报告

可行性研究报告要求根据实际需要和可能，对几种可能的系统建设方案从技术可行性、经济可行性和运营维护可行性三个方面进行论证，并分析利弊，提出建议性结论。

可行性研究报告应包括以下各项内容:

(1)引言。引言包括系统简介和参考资料，内容同立项报告。

(2)对现行系统的分析。内容包括:①组织结构。给出现行系统的组织机构、工作任务与相关部门的关系，地域分布图及距离注解，用图表示。②业务流程。给出现行主要业务系统流程图，给出主要业务流程描述。③工作负荷。描述现行系统的工作和工作量。④费用。给出维持现行系统运行的各项费用开支及总额。⑤人员。给出现行系统的人员状况。⑥设备。给出现行系统的设备及使用状况。⑦给出计算机应用情况。基本配置、使用效率和效益、局限性(列出计算机使用过程中处理速度、响应时间、数据存储能力、处理功能等方面的各种主要局限性)。⑧问题和要求。列出现行系统的组织体系、工作效率、人员、设备以及计算机配置、运行效率等问题和新要求。

(3)拟建系统的候选规模及方案。内容包括:①拟建系统的目标。从改进管理手段，提高和改进管理信息服务，增强资源共享，减少人力和设备费用，提高人员利用率，提高社会和经济效益等方面提出拟建系统的目标。②系统的建设规模及初步设计方案。说明拟建系统的规模、组成和结构。③系统建设的实施计划。④投资方案。说明投资的数量、来源和时间安排。⑤人员培训及补充方案。说明新系统对人员的数量和质量的要求，对现有人员进行培训及新增人员的计划。⑥其他可供选择的方案。

(4)可行性研究。内容包括:

①系统建设的技术可行性。对现有可用技术的估价，分析使用现有技术进行系统建设的可行性，对技术的发展可能产生的影响的预测。

②系统建设的经济可行性。包括现有经济条件分析(经济发展水平与所需投资的适应性分析)、系统建设费用分析(包括土建费用、计算机系统和其他软硬件系统、技术开发和人员培训费用)、营运费用分析(包括人员工资、水电等公共设施的使用、软硬件系统的租赁和维护、数据收集和录入、通信、消耗材料以及其他等费用)、对系统效益的估计(包括对直接的和间接的经济效益以及社会效益的分析)以及经济可行性分析(提出投资的可能性、效益/费用比等)。

③系统运行可行性分析。系统对组织机构的影响及其可行性、人员计划的可行性(包括现有人员的状况及其对系统的适应性，现有人员可接受培训的程度及培训设施的能力，人员补充计划的可行性等)、环境条件的可行性(公共设施的能力以及自然环境或环境保护的影响)。

④几种方案的比较研究。

⑤建设性结论。说明可以按某方案立即开始建设，或待某些条件成熟后再按某方案建设，或不必进行实施。

3.系统设计任务书

系统设计任务书是在系统可行性研究的基础上，对选定的系统建设的最佳方案进行更为深入的研究、分析，进一步明确系统建设的目标和规模，并制定系统建设的初步计划。

系统设计任务书应包括以下各项内容。

(1)系统的目标及任务。内容包括:

①背景。现代科学技术和城市建设的高速发展及其对信息系统的需求。

②目标和任务。列出系统建设的目标及达到目标的衡量标准，简述系统的主要任务。

(2)系统的结构。

(3)系统的规模及建设计划。内容包括:

①系统的规模。提出收集信息的范围、服务范围和对象、服务内容、处理能力和投资规模等。

②系统建设初步计划。

③投资安排计划。

④人员计划。提出人员需求及对现有人员进行培训及新增人员计划。

(4)问题和措施。提出系统建设的组织保证及对可预见的问题拟采取的措施。

4.用户需求分析报告

用户需求分析报告是根据系统设计任务书，并在用户需求调查的基础上编制的LIS工程建设的主要文件，是进行系统设计的主要依据。用户需求分析报告应包括以下各项内容。

(1)引言。内容包括:

①系统简介。简要介绍本系统的名称、基本功能和编制本说明书的目的，并列出本系统的任务提出者、开发者及其主管部门。

②参考资料。列出本系统经核准的计划任务书、合同或上级机关批文;列出本系统用到的全部资料，包括这些资料的作者、标题、编号、发表日期及出版单位，必要时说明这些资料的来源。

(2)概述。内容包括:

①系统的描述。叙述开发本系统的意图、应用目标和作用范围等，解释所开发的系统与其他有关系统的关系，以及系统内各部分之间的关系。

②主要功能。列出本系统的主要功能及简要说明。

③实现语言。列出所采用的程序设计语言。

④用户特点。列出本系统用户对系统开发形成约束条件的重要特点。

⑤一般约束。管理制度、硬件限制、并行操作、实时性能、检查功能、控制功能、信号交换协议、应用的临界点、安全保密的考虑。

(3)用户业务管理现状分析。详细分析用户部门有关各项业务的现状，包括业务流程、数据流程、数据量、应用频率、数据源情况，业务管理依据的行政和技术文件，各阶段业务之间的关系，现有组织机构和为适应GIS技术而应作的组织机构、业务流程、管理方法等方面的调整，用户的职权范围和对本系统功能的要求等。

(4)用户具体需求。内容包括:

①功能需求。逐项说明用户对本系统各项功能的详细需求，描述为完成各项功能所需要的输入、处理和输出等。

②外部接口需求。用户界面(说明系统与用户间的界面需求。如:菜单格式、打印格式、输入和输出时间等)、硬件接口(说明系统对硬件的基本要求)、软件接口(说明本系统对其他软件和系统软件的需求)、通讯接口(说明本系统对各种通信软件的需求和接口要求)。

③性能需求。说明系统中数据、数学方法和传输精度的要求;说明系统的时间特性要求;说明系统适应需求变化能力的要求。

④设计约束。须遵守的其他标准(说明由现有的标准或规则而衍生的需求，如:报表格式、数据命名、追踪检查等)、硬件的限制(说明对系统设计构成约束的硬件条件)。

⑤属性需求。可使用性(定义某些需求，以保证系统的可使用性。如:检查点、恢复方法和重启动性等)、安全性(说明如何保护系统软件，以防止偶然或恶意的访问、使用、修改或泄密)、可维护性(说明保证系统维护的若干要求)、可移植性(说明软、硬件环境的兼容性及移植环境的约束等)。

⑥其他需求。数据库(说明系统中数据库部分的需求)、操作(说明用户的常规操作和特殊操作)、故障处理(列出可能发生的软、硬件故障及处理要求)。

(5)数据需求。内容包括:

①数据描述。列出静态数据、动态输入数据、动态输出数据。

②数据采集。应按数据的逻辑分组说明数据采集的要求和范围，指明数据的采集者。包括:数据源、输入介质和设备、接受者、输出介质和设备、数据值的范围、更新和处理频度。

③数据字典。列出系统中出现的全部数据内容并说明之。

(6)提出测试的准则。

5.系统总体设计方案

系统总体设计方案是从总体角度对系统建设的主要技术设计方案进行说明，以便系统建设有一个可遵循的技术规范。同时，还要对设计指导思想和所采用的技术方法进行说明。它是上级主管部门审查和协调系统建设过程的依据，是下一阶段工作的基础。

系统总体设计方案应包括以下各项内容:

(1)引言。内容包括:

①系统简介。简要介绍系统的名称、目标和功能，并说明系统建设的组织单位、服务对象及与其他系统或机构的联系。

②参考资料。列出有关文件的作者、标题、编号、发表日期和出版单位。必要时说明这些文件资料的来源。

(2)系统总体设计技术方案。内容包括:

①模块设计。在本阶段，首先划分系统内部基础模块结构，然后确定系统的总体结构。它是编写程序的依据。画出模块结构图，图中需简述模块的名称(列出系统中各主要功能的结构图名称和它们之间的关系)、功能(用文字简单说明主要模块结构图应具有的功能)和接口关系。

②代码设计。代码设计是LIS建设的重要设计内容之一。它是进行信息分类、标识，以便对数据进行存储、管理和查询检索的关键，也用于指定数据的处理方法，区别数据类型和指定计算机处理的内容。

③输入设计。它担负着将系统外的数据以一定的格式输入计算机的任务，它直接影响到人工系统和机器系统的工作质量。输入设计的原则是确保系统输入信息的正确无误。应说明系统的主要输入信息，以及对输入承担者的安排和主要功能要求。简要说明各主要输入数据的类型、来源和所采用的设备、介质、格式、数值范围、精度等。简述所用的数据校验方法及其效果。如果输入数据同某一接口软件有关，还应说明该接口软件的来源。

④输出设计。它是指计算机将原始输入数据进行处理，将其加工成满足用户使用要求的格式，并提供给用户。输出不仅有一定的格式要求，而且有必要的介质和设备支撑。

⑤数据库设计说明。编制数据库设计说明的目的是对所设计数据库中数据的逻辑结构和物理结构做出具体的设计规定。

a.概述说明设计开发数据库的意图、应用目标、作用范围、主要功能以及有关数据库开发的背景材料。

b.需求规定主要描述数据库性能规定，包括数据精度、存取数据的有效性、响应时间、数据的转换和传送时间以及其他专门要求。

c.运行环境要求简述运行数据库的硬设备及其专门功能，列出支撑软件并说明测试用的软件，说明在安全保密以及其他有关方面的要求。

d.设计考虑简要说明本系统(或子系统)内所使用的数据结构中，有关数据分层、数据项、记录、文件的标识、定义、长度及它们之间的相互关系。

简要说明本系统(或子系统)内所使用的数据结构中有关数据项的存储要求、访问方法、存取单位、存取的物理关系(索引、设备和存储区域)、设计考虑和保密处理。

⑥模型库及方法库设计。

⑦网络设计。即系统的网络结构和网络功能设计。

⑧安全保密设计。

⑨评价、验收。对系统的每一部分设计都应有相应的评价。评价的结果是验收的重要根据。

⑩实施方案说明书。系统设计阶段完成以后就要确定系统实施方案，书写实施方案说明书。实施方案说明书是系统实施阶段的依据。

a.实施方案说明对系统名称、子系统名称、程序名称、程序语言、使用的设备等逐项说明;对数据长度、文件名称和形式、编号、构成记录的各数据项的名称和内容等逐项说明;对进行程序设计的处理内容进行详细说明。

b.实施总计划对系统建设中需完成的各项工作(包括文件编制、审批、打印、用户培训工作、使用设备的安排工作等)，按层次进行分解，指明每项任务的要求。给出每项工作任务(包括文件编制)的预定开始日期和完成日期，规定各项工作任务完成的先后顺序以及每项工作任务完成的标志。逐项列出本系统建设所需要的费用(包括办公费、差旅费、机时费、资料费、通信设备和专用设备的租金等)。

c.实施方案的审批由于实施方案是下一阶段工作的依据，所以待报批的实施方案要经用户、系统研制人员、程序员、操作员、专家和管理人员审议。一经批准的实施方案就不能随意改动。

6.系统实施总结报告

编制系统实施总结报告的目的是按年度、半年度、季度或按实施计划阶段向上级主管部门申报计划实施过程中的情况，使上级主管部门在布置、检查工作时有据可依。

系统实施总结报告应包括下列内容:

1)引言

(1)系统简介。简要介绍开发的系统名称、基本功能和编制本报告的目的，并列出该系统的任务提出者、开发者及其主管部门。

(2)参考资料。列出本系统有关的主要参考资料，包括这些资料的作者、名称、编号、出版日期和单位。必要时说明这些资料的来源。

2)系统实施情况

(1)工程情况。列出实施过程中各阶段工程进展的实际情况。包括:应用软件开发的实际情况及其进度、硬件配置的实际情况及其进度、数据库开发的实际情况及其进度、机房装修等土建施工的实际情况及其进度。

(2)投资情况。列出本系统资金筹集及使用的情况。包括资金筹集情况(列出资金的来源及金额)、资金的开支情况(列出实施过程中各阶段实际花费的资金数额及其用途)。

(3)人员情况。列出实施过程中各阶段参加工作的各类人员的数量、来源和培训情况。包括:人员调剂(各阶段参加人员的数量、来源)、培训(列出系统转轨业务培训、数字化人员培训、操作人员培训、维护人员培训、管理人员培训的内容、时间、参加的人数以及实际效果)。

3)问题与解决情况

列出在系统实施过程中遇到的问题及其解决情况。包括:工程进展中的问题及解决情况，资金筹集及使用中的问题及其解决情况，人员调剂及培训中的问题及其解决情况。

7.系统测试报告

系统测试报告是在对系统硬设备、软件进行严格的功能和性能测试过程中形成的系统建设文件。系统测试必须按照系统总体说明书所要求的系统功能和性能进行，并应对测试结果进行分析研究。系统测试报告应包括下列内容:

1)引言

(1)系统简介。内容同系统实施总结报告。

(2)测试依据。说明进行本项测试的主要依据。

(3)环境。列出被测试系统运行的软件、硬件环境和进行本项测试的软件、硬件实施环境。

2)测试执行情况

列出各功能模块测试中所得到的动态输入/输出数据、图形(包括内部生成数据、图形的输出)的结果，同动态输入/输出预期结果相比较，列出发现的问题。

3)系统功能结论

逐一简述各项系统的功能，说明为满足此项功能而设计的软件性能以及经过一项或多项测试已证实的性能。同时，还应说明测试的输出结果和范围，列出就该功能而言在测试过程中发现的缺陷和局限性。

4)评价

说明该系统的开发是否达到预期的目标，能否交付使用。

8.用户手册

详细描述LIS产品的功能、性能和用户界面，使用户了解如何使用该软件。用户手册应包括下列内容:

1)引言

(1)编写目的。阐明编写手册的目的，指明读者对象。

(2)项目背景。说明项目来源、委托单位、开发单位及主管部门。

(3)定义。列出手册中使用的专门术语的定义和缩写词的原意。

(4)参考资料。列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源。有关资料包括:项目的计划任务书、合同或批文;项目开发计划;需求规格说明书;总体设计说明书;详细设计说明书;测试计划;手册中引用的其他资料，采用的GIS软件工程标准或软件工程规范。

2)软件概述

(1)目标和功能。

(2)性能。包括:数据精确度(包括输入、输出及处理数据的精度)、时间特性(如响应时间、处理时间、数据传输时间等)、灵活性(在操作方式、运行环境需做某些变更时LIS产品的适应能力)。

3)运行环境

(1)硬件。列出LIS系统运行时所需的硬件最小配置，如:计算机型号、主存容量;外存储器、媒体、记录格式、设备型号及数量;输入、输出设备;数据传输设备及数据转换设备的型号及数量。

(2)支持软件。如:操作系统名称及版本号;GIS开发语言或开发平台的名称和版本号;数据库管理系统的名称及版本号;其他必要的支持软件。

4)使用说明

(1)安装和初始化。给出程序的存储形式、操作命令、反馈信息及其含义、表明安装完成测试实例、安装所需的软件工具等。

(2)输入。给出输入数据或参数的要求。

①数据背景说明数据来源、存储媒体、出现频度、限制、质量管理等。

②数据格式如:长度、格式基准、标号、顺序、分隔符、词汇表、省略和重复、控制。

③输入举例

(3)输出。给出每项输出数据的说明。

①数据背景说明输出数据的去向、使用频度、存放媒体、质量管理等。

②数据格式详细阐明每一输出数据的格式，如首部、主体和尾部的具体形式。

③输出举例

(4)出错和恢复。出错信息及其含义、用户应采取的措施(如修改、恢复、再启动)。

(5)求助查询。说明如何操作。

5)运行说明

(1)运行表。列出每种可能的运行情况，说明其运行目的。

(2)运行步骤。按顺序说明每种运行的步骤。

6)非常规过程

提供应急或非常规操作的必要信息及操作步骤，如出错处理操作、向后备系统切换操作以及维护人员须知的操作和注意事项。

7)操作命令一览表

按字母顺序逐个列出全部操作命令的格式、功能及参数说明。

8)程序文件(或命令文件)和数据文件一览表

按文件名称、字母顺序或按功能与模块分类顺序逐个列出文件名称、标识符及说明。

最后，用户操作举例，一般附在手册之后。

9.用户使用报告

用户通过试用，在提交的使用报告中应包括以下内容:

1)引言

(1)系统简介。简要介绍本系统的名称、基本功能和编写本报告的主要目的，并说明本系统的任务提出者、开发者及其主管部门。

(2)参考资料。列出使用本系统用到的全部资料的作者、名称、编号、出版日期及单位。必要时说明这些资料的来源。

2)评价

评价系统功能是否符合要求、系统的实用性和可靠性、系统的可操作性、系统的适应性和可维护性等。

10.系统验收报告

系统验收报告是用户从运行的角度对所建成的新系统进行评价验收时形成的系统建设文件。验收时用户要调查系统实施后是否达到设计时提出的预期目标，并给出是否可以通过验收的结论。系统验收报告应包括以下内容:

1)引言

(1)系统简介。简要介绍被验收系统的名称、基本功能和编写本报告的主要目的，并说明被验收系统的任务提出者、开发者及其主管部门。

(2)验收依据。本系统核准的计划任务书、合同或上级机关的批文、总体设计和子系统设计方案及系统用户需求报告等有关资料。

2)验收

(1)验收环境。列出参加验收工作的有关人员名单、工作单位、职称等情况，给出系统验收所采用的方法及与验收有关的其他环境。

(2)验收步骤。对照系统设计方案和系统用户需求报告，列出验收系统各个组成部分的步骤。

(3)验收内容。包括:

①文档验收。说明被验收系统的文件资料档案是否齐全，及其质量情况。

②软件验收。列出被验收系统的软件功能、性能是否达到计划任务书、合同或上级部门批文和设计的要求;系统运行是否满足用户要求。

③数据库验收。说明被验收系统的数据库内容是否完整、数据的标准化和质量是否符合要求。

3)评价

根据文档和软件的验收情况，说明该系统是否通过验收。

11.系统建设总结报告

系统建设总结报告是对整个系统开发工作的一个全面的评价性文件，它应包括以下各项内容:

1)引言

(1)系统简介:简要介绍本系统的名称、开发目的，并列出系统建设的组织单位、开发者和用户。

(2)参考资料:列出有关文件的作者、文献名称、编号、发表日期和出版单位。必要时说明这些文件资料的来源。

2)实际开发结果

(1)系统构成:说明实际开发系统的结构。

(2)主要性能和功能:列出本系统实际具有的主要功能和性能，对照可行性研究报告和系统设计任务书的有关内容，说明原定开发目标是否已经达到。

(3)进度:列出原定计划和实际进度，并加以对比分析。

(4)费用:列出原定的计划费用和实际费用，并加以对比分析。

3)开发工作评价

(1)系统质量评价:说明主要功能与原设计预期要求的差距。

(2)技术方法评价:对在开发中使用的技术、方法、工具和手段的评价。

(3)出错原因分析:给出开发中出现的错误的原因分析。

(4)经验和教训:列出本系统开发工作任务过程中所取得的最主要的经验与教训，并提出对今后开发工作的建议。