IT交接事项.doc

IT交接事项 IT交接最重要内容是计算机软件和网络建设文档的交接，计算机软件包括计算机程序数据文是计算机软件中不可缺少的组成部分，它的作用是：记录开发过程中的技术信息，便于协调以后的软件开发、使用和修改；提供对软件的有关运行、维护和培训的信息，便于管理人员、开发人员、操作人员和用户之间相互了解彼此的工作；软件的功能和性能，使能判定该软件能否服务于自己的需要。文程序用户计算机软件计算机软件计算机软件文文 附件一： 软件代码文档 一 目的 提高代码的可读性、系统的稳定性及降低维护和升级的成本。 二 要求 1．注释 （1）编写代码期间注释要求占程序总量15%以上。 （2）每个模块、类顶部必须说明模块名称、功能描述等。 （3）每个过程、函数、方法等开头部分必须说明功能、参数、返回值、原数据和目标数据数据结构等等。 （4）变量定义的行末应当对变量给出注释。 （5）程序在实现关键算法的地方应当给出注释。 2．变量、函数、过程、控件、类等命名规则 （1）变量命名采用[作用范围][数据类型][自定义名称]规则定义，要求看到变量名就能直观的看出其范围和数据类型。 （2）函数、过程、方法、事件等命名应尽量做到观其名知其义。 （3）控件的命名采用[控件类型][自定义名]规则定义,要求通过名字能直观看出控件类型。 （4）自定义命名空间规则，要求能顾名思义。 3．源代码规则 （1）风格约定：采用缩进的格式保存程序的层次结构。要求能直观的看出循环、判断等层次结构。 （2）对数据库操作只能使用标准SQL语句 附件二： 系统设计说明书这里所说的系统是指程序系统。编制的目的是说明对程序 系统的设计考虑，包括程序系统的基本处。流程、程序系统的组织结构、模块划分、功能分配、接口设计。 运行设计、数据结构设计和出错处理设计等，为程序的详细设计提供基础。编制概要设计说明书的内容要求如下：a.待开发软件系统的名称； b.列出此项目的任务提出者、开发者、用户以及将运行该软件的计算中心。 1.3定义 列出本文件中用到的专门术语的定义和外文首字母组词的原词组。 1.4参考资料 列出有关的参考资料，如：本项目经批准的计划任务书或合同、上级机关的批文；属于本项目的其他已发表的文件；本文件中各处引用的文件、资料，包括用到的软件开发标准。 2 总体设计 2.1需求规定 说明对本系统的主要的输入和输出项目、处理的功能性能要求。 2.2运行环境 简要说明对本系统的运行环境（包括硬件和支持环境）的规定。 2.3基本设计概念和处理流程 说明本系统的基本设计概念和处理流程，建议用图表的形式。 2.4结构 说明本系统的系统元素（各层模块、子程序、公用程序等）的划分，扼要说明每个系统元素的标识符和功能，分层次地给出个元素之间的控制和被控制关系。建议用图表方式。 2.5功能需求与程序的关系可用如下一张矩阵图说明： 程序1 程序2 程序3 … 程序n 功能需求1 √ 功能需求2 √ … 功能需求n √ √ 2.6人工处理过程 说明在本系统的工作过程中不得不含有的人工处理过程（如果有的话）。 2.7尚未解决的问题 说明在概要设计过程中没有解决的问题，而设计者认为在系统完成之前必须解决的问题。 3 接口设计 3.1用户接口 说明将向用户提供的命令和它们的语法结构，以及软件的回答信息。 3.2外部接口 说明本系统同外界的所有接口的安排包括软件与硬件之间的接口、本系统与各支持软件之间的接口关系。例如与各港口单位、联检单位、客户、银行、税务、工商等以及ORACLE数据导出。 3.3内部接口 说明本系统之内的各个系统元素之间接口的安排，例如厦门裕利与厦门裕雄。 4 运行设计 4.1运行模块组合 说明对系统施加不同的外界运行控制时所引起的各种不同的运行模块组合，说明每种运行所历经的内部模块和支持软件。 4.2运行控制 说明每一种外界的运行控制的方式方法和操作步骤。 4.3运行时间 说明每种运行模块组合将占用各种资源的时间。 5 系统数据结构设计 5.1逻辑结构设计要点 给出本系统内所使用的每个数据结构的名称、标识符以及它们之中每个数据项、记录、文卷和系的标识、定义、长度及它们之间的层次的或表格的相互关系。 5.2物理结构设计要点 给出本系统内所使用的每个数据结构中的每个数据项的存储要求，访问方法、存取单位、存取的物理关系（索引、设备、存储区域）、设计考虑和必威体育官网网址条件。 5.3数据结构与程序的关系 为了说明数据结构与程序的关系，可采用如下的矩阵图形式： 程序1 程序2 程序3 … 程序n 数据结构1 √ 数据结构2 √