XX项目-详细设计说明书讲义.docVIP

创建日期：2016年12月2日 当前版本：V1.1 创建人： XX系统 详细设计说明书 文档修订记录 版本 修改人 修改日期 AMD 修改说明 V1.0 A 创建版本 V1.1 MD 格式调整、内容修改 添加，M-修改，D-删除） 目录 1. 引言 1 1.1. 编写目的 1 1.2. 项目背景 1 1.3. 预期读者 2 1.4. 名词术语 2 1.5. 参考资料 2 1.5.1. 地理信息标准 2 1.5.2. 软件工程标准 2 2. 总体框架设计 3 2.1. 系统总体架构设计 3 2.2. 关键技术 5 3. 系统功能设计 8 3.1. 功能模块一 8 3.1.1. 功能描述 8 3.1.2. 输入项 8 3.1.3. 输出项 8 3.1.4. 逻辑流程 8 3.1.5. 接口 9 3.1.6. 实现算法 9 3.1.7. 限制条件 9 3.2. 功能模块二 9 3.2.1. 功能描述 9 3.2.2. 输入项 9 3.2.3. 输出项 10 3.2.4. 逻辑流程 10 3.2.5. 接口 10 3.2.6. 实现算法 10 3.2.7. 限制条件 10 4. 出错处理 11 4.1. 出错信息设计 11 4.2. 异常情况处理 11 5. 系统性能保障措施 12 5.1. 可靠性 12 5.2. 易用性 12 5.3. 高效性 12 引言 编写目的 为了明确系统实现功能，提供明确目标指导开发过程，最终完整实现系统建设项目，编写了本详细说明书。 供开发人员使用，作为系统开发的依据。 作为项目验收标准之一。 软件维护的参考资料。 另外，编写此文档为了能够使用户和系统的开发人员更好的沟通，能够对系统的功能达成一致，确定出系统应该实现哪些功能，不实现哪些功能，便于用户与开发商协调工作，为软件系统的后续开发完善提供便利。 项目背景 预期读者 本文档的阅读对象是系统设计人员、软件开发人员、业务规范设计人员、软件测试人员、项目评审人员、系统安装人员及用户代表。 名词术语 术语/名词 说明 参考资料 地理信息标准 本项目在设计和建设时，将严格遵循现有的国家标准、专业标准、行业规范和技术规定，保证数据库建设符合国家和行业地理空间信息系统建设标准规范的技术要求。 软件工程标准 为保证系统的成功开发，需要贯彻现有的软件工程标准规范，以利于软件开发过程的控制、监督、管理，提高软件开发的质量，缩短开发时间，减少开发和维护所需费用，便于协作、交流、沟通，使软件开发工作更加科学、更有效率、更具成效，系统更贴近用户业务要求。 总体框架 系统总体架构设计 关键技术 系统功能设计 功能模块一 功能描述 具体描述此模块实现的功能点。 步骤 信息字段 说明 步骤 信息字段 说明 示例如下： 接口 描述该功能模块的系统接口 实现算法 功能模块一设计 无。 功能模块二 功能描述 具体描述此模块实现的功能点。 步骤 信息字段 说明 步骤 信息字段 说明 流程图 接口 描述该功能模块的系统接口 实现算法 功能模块设计 无。 出错处理 出错信息设计 对于系统的异常，除了在用户界面中展示理解的提示外，还会在后台记录下相关信息，以供开发人员异常信息分析定位相关 异常情况处理 系统发生异常时，系统会发出相关信息窗口或者在相关界面上输出提示语句用户可以根据提示语句进行排除若无法解决可管理员进而还可以联系维保人员进行处理。  可靠性 系统考虑了在相关因素，可靠性 易用性 系统的开放要“以人为本”，充分考虑广州房地产测绘院所各个部门实际工作的需要，贴近用户的需求与习惯做法，做到功能强大，界面友好和美观，操作简单，使用方便。充分实现信息资源的共享，降低工作人员的工作强度，实现各项业务办理的计算机协同工作环境，使测管所各部门的相关工作人员办理业务时能方便准确获得信息。 高效性 在系统设计、开发和应用时，应从系统结构、技术措施、软硬件平台、技术服务和维护响应能力等方面综合考虑，确保系统较高的性能。可维护性 为了确保系统的可持续发展，系统应具有较强的可维护性和扩展性。当机构调整、人事变动、业务内容与流程变更时，能方便地进行系统流程和功能的调整，以适应系统需求变化；系统能够方便地进行管理与维护，软、硬件的升级不影响正常运作，系统功能、结构以及数据库可方便地扩展。 XX系统 详细设计说明书 第3页