详细设计设计说明书.docx

1、详细设计设计说明书文档编号：详细设计说明书（程序模块部分）版本：V1.24文档信息及修订记录文档名称称详细设计说明书编写规范文档编号文档类型规范文档密级机密 秘密 内部公开文档主送公司全体员工文档抄送修 订 人修订日期修订说明版本/修订 目 录3 程序1（标识符）设计说明 23.1 程序描述 23.2 功能 23.3 性能 23.4 输入项 23.5 输出项 23.6 算法 33.7 流程逻辑 33.8 接口 33.9 存储分配 33.10 注释设计 33.11 限制条件 33.12 测试计划 43.13 尚未解决的问题 41 程序1（标识符）设计说明我主要负责三个模块客户管理，客户联络管理，

2、产品档案管理。1.1 程序描述客户管理：客户信息主要为公司资源由后台导入，销售人员领取客户并跟踪。销售人员跟踪客户上限为N，跟踪后别的销售人员就无法跟踪，如果跟踪客户意向明确的销售人员可以申请客户保护，保护客户数为P，只有申请保护的客户销售人员才能下单。保护客户Y天内没有签单的，自动释放到公司资源库，X天后才能被重新跟踪。销售人员跟踪的客户连续M天无跟踪记录自动释放到公司资源库，X天后才能被重新跟踪。销售人员可以自己添加客户，但添加的客户不能与公司资源库客户重复，如果重复将不能添加，添加成功的客户包含在跟踪人数N内，释放规则同上，下单规则同上。员工离职，员工所跟踪或保护客户全部释放到公司资源库

3、，X天后才能被重新跟踪。员工客户可以自行释放客户到公司资源库，X天后才能被重新跟踪。部门经理可见部门员工跟踪客户，销售总监可见所有员工跟踪客户。客户联络管理：客户联络管理是为保证与客户及时有效沟通而设置的模块，它能记录、查询客户的日常交流信息，及时跟进客户的需求。通过权限控制，只能操作销售人员自己跟踪和保护的客户。部门经理可见部门员工跟踪客户，销售总监可见所有员工跟踪客户。产品档案管理: 产品管理部门自行添加产品，可自定义产品属性，费用等。并且可以自定义产品的订单流向（流向的处理部门）。1.2 功能客户管理:客户联络管理:产品档案管理:1.3 性能（1）可靠性：不会因为断电、系统瘫痪导致数据无

4、法保存。（2）正确性：在操作正确的情况下不会出现错误。（3）容错能力：不会因为系统繁忙或者机器过热而导致系统崩溃等不良后果。（4）可移植性：系统可以移植到不同的系统环境下。用户界面需求 界面的原则要求方便、简洁、美观、一致等；整个系统的界面风格要统一，某些功能模块的特殊的界面要求要满足规范。(1)输入设备：界面要提供与键盘、鼠标、条码扫描器、pos机等硬件的连接部分。(2)输出设备：界面要有供操作显示器、打印机等功能的设计。(3)显示风格：图形界面美观、字符界面清晰、IE界面流畅。(4)显示方式：1024768、640480等。(5)输出格式：要有显示布局、打印格式等规范选择。接口需求 图书馆

5、信息硬件接口编号接口名称接口规范接口标准入口参数出口参数传输速率1条码扫描器通用的接口规范通用标准图书条码图书借还者信息40M/S速率较快2Pos机通用的接口规范通用标准一卡通卡号读者一卡通的基本信息与借还书记录106KBPS速率较快1.4 输入这是客户管理的输入和输出。1.4.1 输入项员工编号 staffid int员工姓名 staffname varchar(20)密码 password varchar(20)所属部门 apartment varchar(10)角色 role int年龄 age int性别 sex varchar(10)学历 education varchar(20)地

6、址 address varchar(50)手机号 phone number(11)常用邮箱地址 email varchar(50)1.4.2 输入界面1.5 输出 客户管理是否成功。1.5.1 输出项 1.5.2 输出界面1.6 算法这是客户管理最基本的功能，客户的新建。首先要检查输入的各种信息是否完全，以及是否符合规范。首先检查员工编号是否输入，是否符合要求，密码是否输入，是否符合要求，员工姓名是否输入，是否符合要求，所属部门是否输入，是否符合要求，角色，年龄，性别，手机号，邮箱同上。如果上述均没有问题的话，检查下数据库中的员工编号是否存在，如果已经存在的话必须提示该编号已存在，如果不存在的

7、话方可插入到数据库中。1.7 流程逻辑1.8 输入这是客户联络管理的输入，输出设计。1.9 输入项客户编号 costomerid int客户姓名 customername varvchar(20)员工编号 staffid int员工姓名 staffname varchar(20)联络日期 liandate date1.10 输入界面1.11 输出客户联络管理保存成功或失败。1.12 输出项1.13 输出界面1.14 输入这是产品档案管理的输入与输出1.15 输入项产品编号 productid int所属类别 upproductid int产品名称 Productname Varchar(50)

8、生产日期 Productdate date所属公司 Company int1.16 输入界面1.17 输出判断产品编号及其他各项的输入是否符合要求，检查产品编号是否存在，如果均符合要求的话就弹出界面 产品保存成功，否则的话弹出提示信息，哪里输入不正确。1.18 输出项是否保存成功1.19 输出界面1.20 接口用图的形式说明本程序所隶属的上一层模块及隶属于本程序的下一层模块、子程序，说明参数赋值和调用方式，说明与本程序相直接关联的数据结构（数据库、数据文卷）。本程序相直接关联的数据库及数据结构：数据表，字典代码表1.21 存储分配根据需要，说明本程序的存储分配。1.22 注释设计说明准备在本程

9、序中安排的注释，如：a 加在模块首部的注释；必要的注释信息，包括：文件名；版本号；作者；生成日期；模块功能描述（如功能、主要算法、内部各部分之间的关系、该文件与其它文件关系等）；主要函数或过程清单及本文件历史修改记录等。例如：/* Copyright(版权信息)：Copyright ? XXX* All right reserved.*project(项目)：XXX*Create Date(创建日期)： * author（作者）：* version（版本）： x.xx*模块功能描述： * Modification history（）： ()*1. 8:20:00 * 原因及改动说明*2.*/b

10、 加在各分枝点处的注释；函数或过程名称；功能描述；输入、输出及返回值说明；编写依据（如业务逻辑、算法、模块需求等）；调用关系及被调用关系说明等see 对类、属性、方法的说明 参考转向，也就是相关主题 param 对方法的说明 对方法中某参数的说明 return 对方法的说明 对方法返回值的说明 exception 对方法的说明 对方法可能抛出的异常进行说明例如： /* * Description :checkout 提款 * param Hashtable cart info * param OrderBean order info * return String */c 对各变量的功能、范围、缺省条件等所加的注释；d 对使用的逻辑所加的注释等等。1.23 限制条件说明本程序运行中所受到的限制条件（如业务规则等）。1.24 测试计划说明对本程序进行单体测试的计划，包括对测试的技术要求、输入数据、预期结果、进度安排、人员职责、设备条件驱动程序及桩模块等的规定。1.25 尚未解决的问题说明在本程序的设计中尚未解决而设计者认为在软件完成之前应解决的问题。