详细说明书案例

详细说明书案例

目录

1．引言...2

1.1编写目的...2

1.2项目背景...2

1.3定义...2

1.4参考资料...2

2．总体设计...3

2.1需求概述...3

2.2软件结构...4

3．程序描述...5

3.1功能...5

3.2性能...6

3.3输入项目...6

3.4输出项目...6

3.5算法...6

3.6程序逻辑...7

3.7接口...10

3.7.1外部接口...10

3.7.2内部接口...10

3.8存储分配...10

3.9限制条件...10

3.10测试要点...10

1．引言

1.1编写目的

单位人事管理系统详细设计是设计的第二个阶段，这个阶段的主要任务是在单位人事管理系统概要设计书基础上，对概要设计中产生的功能模块进行过程描述，设计功能模块的内部细节，包括算法和详细数据结构，为编写源代码提供必要的说明。

概要设计解决了软件系统总体结构设计的问题，包括整个软件系统的结构、模块划分、模块功能和模块间的联系等。详细设计则要解决如何实现各个模块的内部功能，即模块设计。具体的说，模块设计就是要为已经产生的单位管理各子系统设计详细的算法。但这并不等同于系统实现阶段用具体的语言编码，它只是对实现细节作精确的描述，这样编码阶段就可以将详细设计中对功能实现的描述，直接翻译、转化为用某种程序设计语言书写的程序

1.2项目背景

1.开发软件的名称：单位人事管理系统

2.项目的任务提出者：全体成员

3.开发者：本项目的全体人员

6.项目使用的软件：SQL Server 2005,MyEclipse8.5,Tomcat5.0;

7.系统：本软件应使用Microsoft Windows 7或Microsoft Windows XP

1.3定义

本文档中没有用到的专门术语的定义和缩写词的原文。

1.4参考资料

A、《项目需求说明》；本项目的全体人员编

B、《项目详细设计说明书》；本项目的全体人员编

C、《项目概要设计说明书》；本项目的全体人员编

参考资料：

《软件工程导论——第5版》张海藩编著清华大学出版社

《实用软件工程》Leszek A.Maciaszek Bruc Lee Liong著

2．总体设计

2.1需求概述

系统将实现对单位的录入，单位法人的录入，专办员的录入，一级单位管理二级单位，二级单位管理三级单位的模式，各单位之间相互联系工作

单位人事管理系统的实现使用MVC(Model-View-Controller，模型-视图-控制器模式)架构模式。

2.2软件结构

MVC模式的目的是实现一种动态的程式设计，对程序的修改和扩展简化，并且使程序某一部分的重复利用成为可能。除此之外MVC模式通过对复杂度的简化使程序结构更加直观。软件系统通过对自身基本部份分离的同时也赋予了各个基本部分应有的功能。专业人员可以通过自身的专长分组：

1.控制器-负责转发请求，对请求进行处理。

2.视图-界面设计人员进行图形界面设计。

3.模型-程序员编写程序应有的功能（实现算法等等）、数据库专家进行数据管理和数据库设计(可以实现具体的功能)。

(MVC三层结构图)

软件基于MyEclipse8.5等作为开发工具，采用JAVA语言，使用Hibernate3.0等技术开发。

MyEclipse是单位人事管理项目的开发环境，可以很快速开发基于JAVA技术的各种类型的项目，是当今使用最广泛的集成开发环境(IDE)。另外，MyEclipse可以无缝地集成各种插件，保证了开发项目的良好扩展性能。开发人力资源管理系统时，我们将Tomcat集成到MyEclipse平台，来完成项目的部署自动化和管理快捷化。

Java不同于一般的编译运行计算机语言和解释执行计算机语言。它首先将源代码编译成字节码，然后依赖各种不同平台上的虚拟机来解释执行字节码，从而实现了“一次编译、到处执行”的跨平台特性。在J2SE1.4.2发布后，Java的运行速度有了大幅提升。Java是一种开放的技术。“Java语言靠群体的力量而非公司的力量”是Sun公司的口号之一，并获得了广大软件开发商的认同。Java编程语言是个简单、面向对象、分布式、解释性、健壮、安全与系统无关、可移植、高性能、多线程和动态的语言。

3．程序描述

3.1功能

1.人事单位的管理：包括：增加单位、删除单位、修改单位。

2.法人代表的管理：包括：添加法人代表、删除法人代表、修改法人代表信息。

3.专办员管理：包括专办员的查询、添加、删除和修改。

4.系统管理员：登陆、权限管理、密码找回、注销。

5.重新登录：用户可以重新以其它用户进行登录。

6.退出：退出该系统。

3.2性能

1.系统的查询效率要高，响应时间要快，得到数据的准确率要高。

2.主要访问的用户有：专办员、法人。相对应法人而言，专办员所需的数据量大，系统的查询效率要高，响应时间要快。

3.为了使单位人事管理系统，不受环境因素与网络因素的影响，如：不受病毒、木马、蠕虫、黑客的入侵与攻击，所以系统要有冗余，以此提高系统的高可靠性。

3.3输入项目

从鼠标、键盘按提示输入。

专办员：输入的数据有用户名、密码、验证码、单位信息；

法人：输入数据：用户名，密码，单位信息；

管理员：输入数据：专办员信息、法人信息、单位信息，管理员信息；

3.4输出项目

依服务器响应从界面输出响应信息。

专办员：单位信息，专办员信息，法人信息，单位中的年检信息，修改密码信息。

法人：单位信息，法人信息，法人信息，权限。

管理员：输出数据：专办员信息、法人信息、单位信息、管理员信息。

3.5算法

本系统采用事件驱动方式，程序过程都处于空间响应事件中，并无特殊算法，大部分均为操作流。因此，算法方面不做深入研究。

3.6程序逻辑

登陆

以下操作需登陆后才能操作

专办员操作

法人代表

系统管理员

3.7接口

3.7.1外部接口

用户界面借接口：采用非常流行的图形界面。

软件接口：运行于Wondows98以上版本。

硬件接口：支持一般X86系列微机。

3.7.2内部接口

由操作系统调用本系统，进入登陆模块。退出系统模块，执行完毕返回操作系统。

3.8存储分配

本程序在高级语言JAVA进行编码，直接的内存分配有JAVA运行时分配。本组件内所依赖的变量、结构要求全部在组件元素内申明。

3.9限制条件

单位管理系统系统必须有专业人员操作，而现在情况是各个单位的领导和法人代表年龄偏大，不熟悉电脑操作，所以用专办员来解决，专办员根据领导的命令来管理本单位的信息，

这造成了一定的局限性；数据更新不及时；设备更新快等等局限性。另外，在界面上控制输入输出，服务器端如果出错也会返回出错信息。

3.10测试要点

使用负载测试模拟实际软件系统所承受的负载条件的系统负荷，通过不断加载（如逐渐增加模拟用户的数量）或其它加载方式来观察不同负载下系统的响应时间和数据吞吐量、系统占用的资源（如CPU、内存）等，以检验系统的行为和特性，以发现系统可能存在的性能瓶颈、内存泄漏、不能实时同步等问题。