概要设计说明书.doc

项目编号项目编号 westd 2005 xx 网通客户资源管理数据库系统网通客户资源管理数据库系统 概要设计说明书概要设计说明书 Version 1 0 项 目 承 担 部 门 软件开发部 撰 写 人 签名 伍安明 完 成 日 期 2005 3 13 本文档使用部 门 主管领导 项目组 客户 市场 维护人员 用户 评审负责人 签名 评 审 日 期 概要设计说明书网通客户资源管理数据库系统 1 目目 录录 1 引言 2 1 1编写目的 2 1 2背景 2 1 3定义 2 1 4参考资料 2 2 范围 2 2 1系统主要目标 2 2 2主要软件需求 3 2 3设计约束 限制 4 2 4运行环境 4 3 软件系统结构设计 4 3 1 设计规范 4 3 1 1界面约定 4 3 1 2命名约定 4 3 1 3 程序编写规范 5 3 2软件体系结构 7 3 2 1软件程序层次结构图 7 3 2 2模块描述 7 3 3功能需求追溯 11 3 4复用策略 11 4 数据设计 11 5 接口设计 11 5 1用户界面设计规则 11 5 2内部接口设计 11 5 3外部接口设计 11 6 出错处理设计 11 7 系统维护设计 12 概要设计说明书网通客户资源管理数据库系统 2 1 引言引言 1 1 编写目的编写目的 编写概要设计说明书的目的是描述 网通客户资源管理数据库系统 项目的概要设计 详细定义软 件总体的功能 系统的接口和数据属性 划分程序基本结构 各程序名称和功能 以便于软件详细设计和 编程 预期的读者有软件的开发设计人员 测试人员 维护人员 公司及部门负责人 客户单位相关人 员 1 2 背景背景 1 2 1 待开发的软件系统的名称 系统中文名称 网通客户资源管理数据库系统 系统英文名称 CRMDBS Customer Resource Management Database System 1 2 2 本项目的任务委托单位 四川省网通 开发单位 成都西域数字网络技术有限公司 用户 网通公司维护管理人员和代维公司 1 2 3 项目背景 说明项目背景 介绍本项目与其它软件或其它系统的关系 1 3 定义定义 术语定义及外文首字母词组说明 光电路信息 主要是指从网通骨干机房到最终用户之间的光纤或电缆线路上的 机房 设备 信息 FR Function Requirement 功能需求 1 4 参考资料参考资料 编写本文件用到了以下参考资料 网通资源管理系统需求说明书 来源 舒鹏编写 2005 3 7 概要设计说明书模板 来源 文档模板库 PHP 编程标准 作者 Fredrik Kristiansen 最后修改日期 2000 11 16 2 范围范围 以下内容描述软件概要设计的整体范围 其主要信息来自于 需求说明书 2 1 系统主要目标系统主要目标 将客服资料信息 日常维护信息 维护材料备件信息 客户投诉及反馈信息 装移拆机信息和 光电路信息在网络上进行信息处理 实现信息的及时收集整理和反馈 以加强对维护组及代维公司 的客户服务工作的监控 提高客户服务工作的效率 方便网通公司进行维护的统一管理 促进管理 客服程序的改进 对维护人员 或公司 的工作考评提供依据 概要设计说明书网通客户资源管理数据库系统 3 2 2 主要软件需求主要软件需求 CRMDBS 分为客户资源基础信息 重大客户投诉及反馈 日常维护 维护材料备件管理 装 移撤机管理 光电路管理 系统维护等六个模块 1 客户资源基础信息模块 客户资源基础信息包含 6 个子功能模块 基础信息 建设基础信息 建设能力信息 装撤机信 息 机房信息 光电路信息 a 基础信息子模块 以项目为基础 对项目基本信息进行录入 修改 删除等操作 b 建设基础信息子模块 项目基础信息的建设信息扩展 根据项目基本信息对建设基础信息进行录入 修改 删除等操作 c 建设能力信息子模块 项目基础信息的建设信息扩展 根据项目基本信息与建设基础信息对建设能力信息 进行录入 修改 删除等操作 d 装撤机信息子模块 项目基础信息的装撤机信息扩展 根据装移撤机管理模块添写的每日装机信息进行 统计计算 按系统时间生成本月与本日装机统计信息 并可进行统计信息的录入 修改 删除等操作权限 e 机房信息子模块 根据时间 如 月 对机房情况 费用进行登记管理 代维公司录入 f 光电路信息子模块 项目基础信息的光电路信息扩展 根据项目基本信息填写该项目的光电路信息 其 中节点 机房 详细信息为通用信息 通过可以添加 修改 删除光电路信息 2 重大客户投诉及反馈模块 处理重大客户的投诉 并记录投诉与解决情况 客户经理填写投诉申报表 生成投诉申报 记录 点击记录可弹出记录详细信息 维护组可录入处理结果 3 日常维护模块 查询 考核代维公司 维护组日常工作计划情况 代维公司按规定时间填写日常工作计划 维护组根据时间填写作业计划表 并生成查询 点击记录可查看详细信息 代维公司不可查询维护组作业计划 计划生成为 WORD 文档 通 过链接可以打开相应记录的文档 4 维护材料备件管理模块 库存现有物资的查询与管理 管理员录入库存现有物资清单 其他用户查询 5 装移撤机管理模块 对 装 移 拆 机的所有项目及其情况进行管理 代维公司将每天 装 移 拆 机信息录入 录入 装 撤 移 机信息回馈表 并生成 装 移 拆 机信息记录列表 需要按时间 业务类型 项目 客户经理进行查询 例如 选择 XX 日查询全部项目情况 单个项目情况 累计装 移 拆机数量统计等 选择 XX 时间段查询全部项目情况 单个项目情况 累计装 移 拆机数量统计等 概要设计说明书网通客户资源管理数据库系统 4 选择 XX 项目查询 XX 日装 移 拆机情况 选择 XX 项目查询 XX 时间段装 移 拆机累计情况 选择 XX 客户经理查询其全部项目 单个项目 XX 日装 移 拆机情况 选择 XX 客户经理查询其全部项目 单个项目 XX 时间段装 移 拆机情况 6 光电路信息管理模块 机房光电路设备以及其各端口使用情况管理 录入机房设备资料 包括设备名称 型号等 录入 修改 删除 查询端口以及其使用 状态等 基础信息模块中光电路信息子模块中的节点信息 包括节点与端口信息 根据本模块选择 如果节点占用和故障则光电路信息子模块中无法选择 光电路信息子模块中节点信息选择后更 改本模块中节点信息 7 系统维护模块 用户权限的管理 公共代码数据的录入 修改 删除 数据库备份 数据资料导出为 EXCEL 表 数据库备份为增量备份 用户登录 信息查询 录入 修改 删除需要相应的权限 8 其他专门要求 所有查询清单需要有打印功能 2 3 设计约束 限制设计约束 限制 系统必须于 2005 年 4 月 1 日前完成主体框架 4 月 15 号前投入试运行 2 4 运行环境运行环境 系统采用 B S 模式 Web 服务器采用 WINDOWS2000 操作系统 开发语言为使用 PHP 数据库使 用 SQLSERVER2000 客户端必须能上互联网 在浏览器中输入网址即可登录到系统中 3 软件系统结构设计软件系统结构设计 3 1 设计规范设计规范 编写本部分参考了 Fredrik Kristiansen 编写的 PHP 编程标准 主要对其中的一部分约定 作出强调 在这些方面要求开发人员足够重视 3 1 1界面约定界面约定 规定屏幕界面的总体布局 如菜单行 显示主体 图标按钮 提示信息 出错信息等 规范化 统一风格 用户工作界面采用框架式的结构 主要分为三个 Form 菜单 嵌入式主工作区 公 告 菜单请参照 Outlook 左边的菜单风格做 主工作区页面 要求与主页面的风格保持一致 公告 主要是提示处理用户投诉信息 需即时滚动显示 按钮 风格必须统一 最好能用 CSS 定义好 提示信息 鼠标停留在按钮 图片 链接等对象上时 应在鼠标的右下出现一个提示 信息框 录入 修改 查询页面上的提示信息也须清晰准确 以引导用户正确操作 概要设计说明书网通客户资源管理数据库系统 5 出错信息 出错之后应有准确的错误信息 杜绝英文信息 3 1 2命名约定命名约定 规定系统和子系统名 程序名 数据库表 文件 名 数据名 变量名等的编制规范 所有命名要求使用较为准确表达其含义的英文单词或缩写 数据库的命名数据库的命名 CNCSC CRMDB 子系统名称子系统名称 客户资源基础信息管理 BaseInfo 重大客户投诉及反馈 CustomerAppeal 日常维护管理 DailyTask 维护材料备件管理 MaintenaceMaterial 装移撤机管理 FitOnBackout 电路信息管理 CircuitInfo 文件夹命名文件夹命名 一般采用英文 长度一般不超过 20 个字符 命名采用小写字母 除特殊情况才使用 中文拼音 一些常见的文件夹命名如 images 存放图形文件 flash 存放 Flash 文件 css 存放 CSS 文件 scripts or JS 存放 Javascript 脚本 inc 存放 include 文件 link 存放友情链接 media 存放多媒体文件 等 文件名称统一用小写的英文字母 数字 和下划线的组合 文件扩展名文件扩展名 所有浏览者可见页面使用 html 所有类 函数库文件使用 php 文件结构文件结构 images include parameter config function index images 存放图片文件 include 中是系统是要引用的文件 一般在 parameter 中存放 参数文件 config 中存放配置文件 function 中存放方法文件 如 javascript 的方法等 并按功能模块的分类 将各功能的类也放入其中 类 函数 方法的命名类 函数 方法的命名 原则上使用英文命名 单词首字母大写 对于 function 的命名 最好是主谓宾结构 变量的命名变量的命名 变量名一般要用英文命名 能达到观名知意的效果 用小写字母 使用 作为每个词 的分界 推荐推荐在变量前加上前缀以说明变量的类型 如 整型 int 字符 str 数组 arr 对象 obj 概要设计说明书网通客户资源管理数据库系统 6 3 1 3 程序编写规范程序编写规范 根据 PHP 的特点 制定规范化要求 以使程序易读易懂 可维护 可移植 1 1 注释注释 编写的每个文件 类 函数 方法开始处必须添加块注释 说明它们的作用 编写人 编写日 期等 在功能和方法内部的块注释应该和它们所描述的代码具有一样的缩进格式 块注释之首 应该有一个空行 用于把块注释和代码分割开来 例如 函数用途说明 参数说明 返回值说明 编写人 编写日期 变量的注释只有一行时 写在声明变量之后 变量的注释如果有多行 写在声明变量之前 例如 关于变量的块注释 int instanceVar1 2 2 合理使用空行分隔代码段合理使用空行分隔代码段 应该使用空行将逻辑相关的代码段分隔开 以提高可读性 下列情况应该总是使用两个空行 一个源文件的两个片段 section 之间 类声明声明之间 下列情况应该总是使用一个空行 两个方法之间 方法内的局部变量声明与方法的第一条语句之间 块注释或单行注释之前 一个方法内的两个逻辑段之间 用以提高可读性 3 3 常量常量 位于 for 循环中作为计数器值的数字常量 除了 1 0 和 1 之外 不应被直接写入代码 4 变量的声明格式变量的声明格式 推荐一行一个声明 因为这样以利于写注释 亦即 int Level int Size 概要设计说明书网通客户资源管理数据库系统 7 要优于 int Level Size 不要将不同类型变量的声明放在同一行 例如 int Foo FooArray 错误 声明变量时 在类型和标识符之间用一个空格分隔 也允许使用制表符分隔 例如 int Level 空格分隔 int Size 制表符分隔 全局变量加前缀 g 静态变量加前缀 s 5 语句语句 语句要简单明了 每行至多包含一条语句 例如 argv 正确的 argc 正确的 argv argc 错误的 3 2 软件体系结构软件体系结构 3 2 1软件程序层次结构图 CRMDBS 客户客户 资源资源 基础基础 信息信息 重大重大 客户客户 投诉投诉 及反及反 馈馈 日常日常 维护维护 维护维护 材料材料 备件备件 管理管理 装移装移 拆机拆机 管理管理 光电光电 路管路管 理理 系统系统 维护维护 基础信息 建设能力信息 装撤机信息 杋房信息 光电路信息 建设基础信息 申报记录 处理记录 查询 填报计划 领导查询 查询 录入库存 录入信息 回馈信息 查询 录入杋房资料 录入设备资料 端口使用情况 用户权限管理 数据库备份 代码数据管理 数据导出 概要设计说明书网通客户资源管理数据库系统 8 3 2 2模块描述 下面用 IPO 图结合表对每一软件模块进行描述 1 基础信息管理基础信息管理 2 建设基础信息管理建设基础信息管理 名 称基础信息管理 标 识 子系统 名 称 客户资源基 础信息模块 系统 名称 网通客户资源管 理数据库系统 输入 项目基本信息 档案编码 项目编码 项目名称 项目地址 业务类型 业务片区 客户经理 申报业务 代理商 代理商联系人 联系电话 移交维护时间 维护 单位 维护人员 联系方式 接 口 说 明 输出项目基本信息表 功 能 说 明 对项目的基础信息进行维护 项目基础信息是其它子模块的公共信息 打印项目基本信息列 表 运行环 境说明 简要地说明对本模块的运行环境 包括硬件环境和支持环境 的规定 调用模块 链接到项目建设基础信息 建设能力信息 装撤机信息 机房信息 光路 电路资料 调用关 系说明 被调用模块 添加项目基本信息 查询项目基本信息 输入 数据有效性检查 取项目编号 保存项目信息 提取数据 修改 删除记录 处理 数据是否有效 项目编号是否唯一 显示处理结果 显示项目基本信息列表 显示处理结果 输出 添加记录 查询建设基础信息 输入 数据有效性检查 取项目编号 保存建设基础信息 提取数据 修改 删除记录 处理 数据是否有效 项目基本信息是否已输入 显示处理结果 显示项目建设基础信息列表 显示处理结果 输出 概要设计说明书网通客户资源管理数据库系统 9 3 建设能力信息管理建设能力信息管理 4 装撤机信息管理装撤机信息管理 名 称建设基础信息管理 标 识 子系统 名 称 客户资源基 础信息模块 系统 名称 网通客户资源管理数 据库系统 输入 项目建设的基础信息 接入性质 传输接入施工单位 驻地网施工单位 设备施工单位 项目开通时间 开通业务 上传项目电路或光路图 PPT 文件 接 口 说 明 输出项目建设基础信息表 功 能 说 明 项目基础信息的建设信息扩展 根据项目基本信息对建设基础信息进行录入 修改 删除等操作 打印项目建设基础信息列表 调用模块链接到项目建设能力信息 光路 电路资料调用关 系说明被调用模块 名 称建设能力信息管理 标 识 子系统 名 称 客户资源基 础信息模块 系统 名称 网通客户资源管理数 据库系统 输入 项目建设的能力信息 号段信息 设备能力 线路能力 交换设备实际开通率 交换满配容 量 出局电缆容量 实际用户数 号段信息 连续号段信息 特号 设备能力 接入网类型 传输设备型号 传输满配容量 厂家 交换设备型号 交换满配 容量 厂家 电源设备型号 厂家 数据设备 厂家 传输能力 交换能力 数据能力 线路能力 MDF 容量 出局电缆容量 语音户线点 数据户线点 接 口 说 明 输出项目建设能力信息表 功 能 说 明 项目基础信息的建设信息扩展 根据项目基本信息与建设基础信息对建设能力信息进行录入 修改 删除等操作 打印列表 调用模块链接到项目光路 电路资料调用关 系说明被调用模块 添加记录 查询建设能力信息 输入 数据有效性检查 取项目编号 保存建设能力信息 提取数据 修改 删除记录 处理 数据是否有效 项目基本信息是否已输入 显示处理结果 显示项目建设能力信息列表 显示处理结果 输出 项目装撤机信息 输入 按月 日统计计算 修改 删除结果 处理 本月项目装撤机情况表 处理之后的装撤机情况统计 表 输出 概要设计说明书网通客户资源管理数据库系统 10 5 杋房信息管理 6 光电路信息管理 名 称装撤机信息管理 标 识 子系统 名 称 客户资源基 础信息模块 系统 名称 网通客户资源管理数 据库系统 输入项目装撤信息表 接 口 说 明 输出装撤机情况统计表 一个项目只能有一条装撤情况统计记录 功 能 说 明 根据装移撤机管理模块添写的每日装机信息进行统计计算 按系统时间生成本月与本日装机统计信 息 并可进行统计信息的录入 修改 删除等操作 打印列表 调用模块链接到项目光路 电路资料调用关 系说明被调用模块 名 称机房信息管理 标 识 子系统 名 称 客户资源基 础信息模块 系统 名称 网通客户资源管 理数据库系统 输入 机房信息及管理情况 机房编号 机房名称 机房地址 机房钥匙信息 机房性质 机 房类型 楼层 机房面积 空调类型 出租方单位 个人名称 联系人 租赁期 年租 金 支付方式 费用代缴信息 代维缴费总金额 代维缴费时间 代维公司名称 水费 电费 物管费 接 口 说 明 输出机房管理情况清单 功 能 说 明 代维公司录入机房信息以及代缴费用信息 打印列表 调用模块链接到项目光路 电路资料调用关 系说明被调用模块 添加记录 查询机房信息 输入 数据有效性检查