详细设计说明书v1.0范版

协同办公系统详细设计说明书编写：* 日期：2006-07-02审核：日期：批准：日期：受控状态：是 发布版次：1.0日期：2006-07-02编号：XS 1.0变更记录日期版本变更说明作者2006-07-021.0初始版本王正韬、张敏签字确认系统模块对应章节对应部门负责人签字目 录1引言31.1编写目的31.2背景31.3基线31.4范围41.5定义41.6参考资料42模块命名规则53模块汇总63.1模块汇总表63.2模块关系图74子系统模块设计74.1数据库连接模块74.2公司通讯录模块 Address84.3在线信息模块 Messages114.4名片夹模块 Namecard154.5代办事项模块 Notes204.6个人文件夹模块 PersonalFile244.7日程模块 Schedule304.8用户信息模块 userInformation374.9系统管理模块 systemManage411 引言1.1 编写目的本说明书目的在于明确说明系统各功能的实现方式，指导开发员进行编码。本说明书的预期读者为：项目经理、+Teamgeist项目组开发人员 1.2 背景待开发软件系统的名称：协同办公系统此软件系统任务提出者：项目经理此软件系统任务开发者：*小组1.3 基线协同办公平台需求分析说明书 v1.11.4 范围此说明书主要应用整个软件代码开发的生命周期以及测试周期1.5 定义无1.6 参考资料项目计划V1.2概要设计说明书V1.02 模块命名规则标识符类型命名规则例子包（Packages）一个唯一包名的前缀总是全部小写的ASCIIzimu并且是一个顶级域名，通常是com,edu,gov,mil,net,org,或1981年ISO3166标准所指定的标识国家的英文双字符代码。包名的后续部分根据不同机构各自内部的命名规范而不尽相同。这类命名规范可能以特定目录名的组成来区分部门(department),项目（project），及其（machine），或注册名（login name）。包括基本为全小写的字母com.sun.engcom.apple.quicktime.v2.cs.bovik.cheese类(Classes)类名是一个单词，采用大小写混合的方式，每个单词的首字母大写。尽量使你的类名简洁而富于描述。使用完整单词，避免错写词（除非该错写词被更广泛使用，像URL，HTML）class Raster;class ImageSprite;借口（Interfaces）命名规则：大小写规则与类名相似interface RasterDelegate;interface Storing;方法（Methods）方法名是一个动词，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母音大写run();runFast();getBackground();变量（Variables）除了变量名外，所有实例，包括类，类常量，均采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。变量名不应以下划线或类元符号开头，尽管这在语法上是允许的。变量名应简短且富于描述。变量名的选用应该易于记忆，即，能够指出其用途。尽量避免单个字符的变量名，除非是一次性的临时变量。临时变量通常被取名为i,j,k,m和n，它们一般用于整型；c，d，e，它们一般用于字符型。int I;float myWidth;实例变量(instance Variables)大小写规则和变量名相似，处理前面需要一个下划线int_employeeld;String_name;Customer_customer;常量（Constants）类常量和ANSI常量的声明，应该全部大写，单词间用下划线隔开。（尽量避免ANSI常量，容易引起错误），使用static final进行标明。static final int MIN_WIDTH=4;static final int MAX_WIDTH=999;static final int GET_THE_CPU=1;3 模块汇总3.1 模块汇总表提示：这里模块是指相对独立的软件设计单元，例如对象类、函数包等等。子系统Address公司通讯录模块名称功能简述公司通讯录通过人员姓名检索公司通讯录，通过公司组织树检索公司通讯录子系统Messages在线信息模块名称功能简述收件箱可以查询具体内容、删除信件发件箱可以查询具体内容、增加、删除、修改、发送草稿箱可以查询具体内容、增加、删除、修改、发送搜索可以搜索符合要求的信件并查看信件的具体内容子系统NameCard名片夹模块名称功能简述名片夹可以查询具体内容、增加、删除、修改子系统Notes待办工作模块名称功能简述待办工作可以查看具体内容、增加、删除、修改最近日程可以查看最近五条日程的内容，可以链接到所有日程列表最近留言可以查看最近五条留言的内容，可以链接到所有留言列表子系统PersonalFile个人文件夹模块名称功能简述个人文件夹可以上传、删除文件，可以新建、修改、删除文件夹，可以修改文件夹名及属性共享文件夹可以下载共享文件子系统Schedule日程模块名称功能简述日程管理可以增加、修改、删除日程代办设置可以授予或取消代办权限读者设置可以授予或取消读者权限日程查询可查询日程并查看具体内容子系统UserInfo个人信息管理模块名称功能简述基本信息管理可以修改自己的基本信息密码修改可以修改密码查询他人信息可以查询他人的公开信息子系统DeptManage部门管理模块名称功能简述部门管理可以增加、删除、修改部门，可以修改部门的联系电话子系统RoleManage角色管理模块名称功能简述角色列表管理可以增加、删除、修改角色列表个人角色管理可以修改个人的角色3.2 模块关系图数据库数据库访问接口个人办公个人信息管理名片管理日程安排在线信息个人文件夹登陆认证系统管理公司通讯录角色管理部门管理待办事项会议管理控制器个人办公界面系统管理界面4 子系统模块设计4.1 数据库连接模块功能描述连接数据库接口与属性AbstractDAOgetConnection() : Connection函数功能：返回数据库连接对象 返回值：Connection（数据库连接对象）AbstractDAOFactorycreateDAO(): AbstractDAO函数功能：创建数据库访问类的实例返回值：数据库访问类的实例DAOFactoryBuildergetFactory() : AbstractDAOFactory函数功能：创建DAO工厂类返回值：DAO工厂数据结构与算法采用工厂方法设计模式将DAO的创建与使用者分离，FactoryBuilder负责创建DAOFactory使得使用者不会因DAOFactory的改变而改变补充说明4.2 公司通讯录模块 Address模块名称Address（公司通讯录）功能描述查询通讯录、导出通讯录接口与属性getAddressByValue(key : String, value : String) : Object函数功能：通过输入的查询条件、查询类别查询指定的员工、部门或者所有的员工的通讯资料输入参数：key : String, value : String返回值：UserInfoBean、DeptBean（得到的个人、部门或者所有员工的通讯资料）buildTreeFile() 函数功能：构建树型结构数据结构与算法补充说明用户打开公司通讯录进行查询显示部门通讯录显示个人通讯录文档可自由编辑打印