1、客户资源管理系统系统设计说明书 编制 张颖审核批准版本 V0.1发布日期 2010.1.18更改记录序号 版本 更改处更改内容 更改人/日期 审核人/日期 批准人/日期1 V0.1 新规张颖2010.1.182345目目 录录 1. 文档介绍 .41.1 文档目的 .41.2 文档范围 .41.3 读者对象 .41.4 参考文档 .41.5 术语与缩写解释 .42. 系统概述 .53. 系统总体结构 .54. 用户界面设计 .54.1. 应当遵循的界面设计规范 .54.2. 界面的关系图和工作流程图 .54.3. 主界面 .74.4. 登录画面 .74.5. MENU 画面 .84.6. 美学
2、设计 .84.7. 界面资源设计 .84.7.1 图标资源 .84.7.2 图像资源 .84.7.3 界面组件 .84.8. 其他 .95. 模块设计 .95.1. 模块命名规则 .95.2. 模块汇总表 .95.3 模块关系图 .95.4. 系统的模块设计 .105.5. 其他 .106. 开发环境的配置 .107. 运行环境的配置 .108. 测试环境的配置 .119. 其他 .111. 文档介绍1.1 文档目的编写此文档的目的是详细描述客户资源管理系统中的用户界面设计及模块设计。并对本系统开发、运行及测试环境配置给予详细的说明。1.2 文档范围本文档为该系统的系统设计说明书，详细的说明了
3、“客户资源管理系统”的用户界面设计、界面关系及美学设计等，并对模块设计、结构情况做了详细的阐述。另外对于该系统的开发环境配置、运行环境配置及测试环境配置进行了指定及推荐。本文档主要适用于开发人员进行系统开发，测试人员进行系统测试，同时也为后续的系统维护工作提供了良好的使用说明，也可以作为未来版本升级时的重要参考资料。1.3 读者对象本文档的预期读者为项目管理人员、项目开发人员、项目测试及维护人员。1.4 参考文档1）软件所参照的软件开发标准为：GB8567-88 标准2）XX 公司软件开发标准（2008）3）本项目的需求说明书及产品规格说明书4）戴坚锋， 软件项目开发与实施 ，电子工业出版社，
4、2009。5）邵志东， 软件开发这点事儿软件开发工具手册 ，电子工业出版社，2009。1.5 术语与缩写解释缩写、术语 解 释CSS 层叠样式表， Cascading Style SheetsLOGO 徽标或者商标的英文说法DAO 数据访问对象 Data Access Object，是一种应用程序编程接口CVS 版本控制系统，Concurrent Version System2. 系统概述本系统是通过扫描仪将扫描后的名片数据，传送到服务器上，被发送来的名片信息数据通过 OCR 自动读取，修正后，将数据保存入数据库中。客户可以使用移动设备或计算机，通过互联网对名片数据进行查询和整理；服务用客户端
5、可以对客户的名片信息进行辅助修改。本次项目中，实现的 WEB 应用方面只是实现了可以通过计算机，使用互联网进行名片数据操作的处理；而对移动设备接入，扫描仪数据传送，服务用客户端并没有开发此功能，特此注明。本系统大体分为以下几个模块：用户管理、名片管理、组管理、数据导出、错误管理。3. 系统总体结构整个系统遵循多层次的架构模式，从上到下依次为视图层、控制器层、模型层、持久化层和数据库层。如右图所示。层次间的依赖关系的原则应该是自顶向下的，即上层可以依赖下层，而下层应该尽量减少对上层的依赖。同时层次间的交互应该减少对实现的依赖，通过接口进行交互。这样修改哪一层，对其他层不用做或者做尽量少的改动。4
6、. 用户界面设计4.1. 应当遵循的界面设计规范本系统所有用户界面遵循软件开发标准 GB8567-88 标准进行设计，用户界面设计友好合理，充分考虑到用户的操作习惯，达到用户在需求说明书中对界面的需求要求。4.2. 界面的关系图和工作流程图界面一览：界面 ID 界面名称 用途UI0001 登录画面 用于用户登录UI0002 Menu 画面 提供用户可进行操作的菜单项UI0003 名片信息作成画面 用户通过此画面添加客户资源信息UI0004 名片信息详细画面 用户通过此画面编辑及删除客户资源信息UI0005 主画面 用户进行客户资源管理，可一览客户资源信息并操作UI0006 组管理画面( 弹出)
7、 向现有组中添加名片或新建组视图层控制器层模型层持久化层数据库层UI0007 删除全部名片(弹出) 批量删除名片信息UI0008 名片信息全部更新画面 批量更新名片信息UI0009 组管理画面 新建、编辑、删除及管理组中名片UI0010 同一人物设定画面 对同名名片进行设定UI0011 访问日志画面 查看客户资源访问信息UI0012 文件导出画面 将客户资源以 CSV/XML 形式导出UI0013 公司部门浏览画面 以树型结构查看客户资源的公司部门信息UI0014 用户信息变更画面 修改用户密码UI0015 操作错误画面 显示操作错误原因UI0016 系统错误画面 本系统共通的错误画面界面关系
8、图如下：各界面之间关系图4.3. 主界面客户资源管理系统主界面主要用于查询名片信息，以一览方式显示；还可根据选项不同，弹出相应的画面。4.4. 登录画面登录画面主要用于系统用户登录系统。4.5. Menu 画面用于菜单信息显示。其他界面参见系统概要设计部分。4.6. 美学设计本系统充分考虑到用户的操作习惯，各用户界面组件布局合理。本系统为使界面配色方案协调，对使用的主色，背景色，前景色，按钮大小，文字，格式，表格等进行了统一标准，采用了 CSS 保持了各界面风格的统一。4.7. 界面资源设计4.7.1 图标资源本系统所使用图标资源均来自于互联网，企业未提供相关 Logo。4.7.2 图像资源本
9、系统所使用图像资源均来自于互联网，未做相关开发。4.7.3 界面组件本系统所使用的树型结构显示企业客户资源信息部分为互联网下载的 JS 文件实现。4.8. 其他5. 模块设计5.1. 模块命名规则本系统模块命名规则（类、函数、变量等）遵循 Sun 公司所定义的 Java Source 描述风格。另外本系统所有 DAO 类均以 Dao 为类名后缀，所有 Business 层类均以 Business 作为类名后缀，所有 Action 层类均以 Action 作为类名后缀，所有 Form 实体层类均以 Form 作为类名后缀，所有 Entity 实体层类均以 Entity 作为类名后缀，所有 Val
10、ue 实体层类均以 Value 作为类名后缀。5.2. 模块汇总表本系统采用 4 层架构来实现，分为 UI 层（用户界面） 、实体层（对象表的映射） 、业务层（数据处理）和数据访问层（操作数据库） ，其中 UI 层为 JSP 网站，其他三层均为类库，另外添加一个类库，提供各层都可能用到的公共功能，如验证操作、数据操作等。客户资源管理系统模块汇总模块名称 功能简述用户界面层-jsp 包含所有用户界面文件Action 层 -action（类库） 包含用于处理用户请求的动作类商业逻辑层-business（类库） 包含用于将 Action 及 DAO 分离的商业层类数据访问层-dao（类库） 包含用于
11、对数据库做操作的类通用功能模块-common （类库） 包含可被其他模块共同使用的类Form 实体层-form（类库） 包含对应页面表单项的实体类Entity 实体层-entity（类库） 包含用于在 Action 及 Business 层间传输数据的实体类Value 实体层-value（类库） 包含用于在 Business 及 DAO 层间传输数据的实体类5.3. 模块关系图以下为本系统各模块之间关系图。客户资源管理系统模块关系图5.4. 系统的模块设计模块的具体设计参见客户资源管理系统模块设计(JAVA).xls 。5.5. 其他6. 开发环境的配置类别 标准配置 最低配置计算机硬件 CP
12、U 2.8GHz 以上 内存 2G CPU 2.8GHz 以上 内存 1G软件 操作系统 Windows 2000/2003 Server，数据库版本为 Oracle10g或以上版本，Web 服务器为Tomcat6.0，浏览器 IE6.0 或以上版本操作系统 Windows 2000/XP，数据库版本为 Oracle9i 版本，Web 服务器 Tomcat5.0，浏览器 IE6.0网络通信 公司内部局域网采用 TCP/IP 作为网络通讯协议TCP/IP 作为局部网络通讯协议其他 版本控制推荐采用 CVS 软件7. 运行环境的配置类别 标准配置 最低配置计算机硬件 CPU 2.8GHz 以上 内存 2G CPU 2.8GHz 以上 内存 1G软件 操作系统 Windows 2003 Server，数据库版本为 Oracle10g 或以上版本，Web 服务器为 Tomcat6.0，浏览器 IE6.0 或以上版本操作系统 Windows 2000 Server，数据库版本为 Oracle9i 版本，Web服务器 Tomcat5.0，浏览器 IE6.0
