第3章 实 例
3.1 人力资源管理系统详细设计说明书实例
一、概述 1.编写目的： 本文挡提供给开发人员进行开发参考，以及测试人员编写单元测试
所用。
2.项目背景：
系统名称：HRM人力资源管理系统
开发者：Mark、Michael、Robin、Luke
详细设计的原则和方法：项目整体结构清晰，按照概要设计的结构
实训任务及要求：
实训 任务
1、 了解软件开发周期各阶段的文档。 2、 掌握各文档阐述的内容及作用。 3、 了解文档所采用的国际、国家等相关标准。 4、 了解各文档所涉及的软件知识。 5、 掌握各文档采用的描述工具。 6、 具体编写出2个主要的软件文档。
实训过程中，要严格遵守实训的时间安排，听从 指导教师的指导。正确地完成上述内容，记录实习日 记，规范完整地撰写出实训报告。
及最终工资报表的查询和打印。 职位变更管理：包括职位空缺的维护（新增、删除、修改、查看、
审核），应聘人员的登记、面试安排和考评；员工推荐的登记和考评； 人事和领导的审批；调职记录的维护（新增、删除、修改、查看）。
离职管理模块：包括离职的申请、审批以及离职信息的维护。 培训管理模块：包括培训课程、培训讲师档案的维护；培训需求的 维护（收集、审核）；以及培训课程的安排、培训考核和培训反馈的维 护。 辅助系统模块：包括数据的备份、还原；员工的权限设置；个人密码修 改；以及退出系统功能。
人力资源管理系统（HRM）分为以下六大模块：人事管理、工资管 理、职位变更管理、离职管理、培训管理、辅助系统，各模块的基本功 能如下：
人事管理模块：包括人员档案、个人档案和部门机构的维护（人员 的新增、修改、查看功能；个人档案的修改、查看功能，以及部门机构
的新增、删除、修改、查看功能）。 工资管理模块：包括基本工资的设置；考勤、考核资料的导入；以
几个人为一组完成一个相对完整的软件系统开发 文档，组内成员编写的文档不能重复，文档要严格按 照所采用的标准编写，图表布局要合理规范。
指导教师评语 及成绩
成绩： 签字：
年月日
指导教师
目录 第1章 实训目的与要求
1.1 实训目的 1.2 实训的实验环境 1.3 实训的预备知识 1.4 实训要求 第2章 软件文档及其组成 2.1软件文档的作用及分类 2.2软件文档所采用的标准 2.3 软件文档的主要内容 第3章 实 例 3.1 人力资源管理系统详细设计说明书实例 3.2 人力资源管理系统用户手册实例 第4章 实训日记 第5章 实训总结 参考文献
第2章 软件文档及其组成
2.1软件文档的作用及分类
软件文档可以分为开发文档和产品文档两大类。 开发文档包括：《功能要求》、《投标方案》、《需求分析》、 《技术分析》、《系统分析》、《数据库文档》、《功能函数文档》、 《界面文档》、《编译手册》、《QA文档》、《项目总结》等。 产品文档包括：《产品简介》、《产品演示》、《疑问解答》、 《功能介绍》、 《技术白皮书》、《评测报告》、《安装手册》、 《使用手册》、《维护手册》、 《用户报告》、《销售培训》等。 一、开发文档： 1. 《功能要求》--来源于客户要求和市场调查，是软件开发中最 早期的一个环节。客户提出一个模糊的功能概念，或者要求解决一个实 际问题，或者参照同类软件的一个功能。有软件经验的客户还会提供比 较详细的技术规范书，把他们的要求全部列表书写在文档中，必要时加 以图表解说。这份文档是需求分析的基础。 2. 《投标方案》--根据用户的功能要求，经过与招标方沟通和确 认。 3. 《需求分析》--包括产品概述、主要概念、操作流程、功能列 表和解说、注意事项、系统环境等。 4. 《技术分析》--包括技术选型、技术比较、开发人员、关键技 术问题的解决、技术风险、技术升级方向、技术方案评价，竞争对手技 术分析等。以《需求分析》为基础，进行详细的技术分析，列出本项目 需要使用什么技术方案，有哪些技术问题要解决 ，估计开发期间会碰 到什么困难，技术方案以后如何升级，对本项目的技术有什么评价等。 5. 《系统分析》--包括功能实现、模块组成、功能流程图、函数 接口、数据字典、软件开发需要考虑的各种问题等。以《需求分析》为
2.2软件文档所采用的标准
参照其它工程领域对工程标准划分的方法，软件工程标准主要有两 种划分方法：按标准的类型划分和按标准的范围划分。
一、按标准的类型划分： 按标准的类型划分主要有过程标准、产品标准、行业标准、记法标 准等。过程标准与开发一个产品或从事一项服务的一系列活动或操作有 关。过程标准使用一组方法、工具和技术，给出“谁来做”、“做什
（二）、业务逻辑层 功能描述：对用户基本信息进行管理 模块编号：1.1 模块功能：对用户的基本信息的操作和维护，包括：增加用户基本 信息，修改用户的基本信息，查询用户的基本信息，删除用户 模块名称：UserBiz 命名空间：erBiz 处理：对用户基本信息的增加，修改，查询用户或列表 属性 功能：获取和设置User实体 名称：User 方式：Get & Set
7. 《功能函数文档》--包括变量名、变量初植、功能，函数名， 参数，如何调用、备注、注意事项等。以《系统分析》为基础，进行详 细的说明，列出哪个功能涉及多少个函数，以便以后程序员修改、接手 和扩展。
8. 《界面文档》--包括软件外观、界面素材、编辑工具、文件 名、菜单、按钮和其它界面部件的要求，这里与软件完成后的运行界面 是一致的。
8. 《使用手册》--包括产品简介、功能列表、功能描述和解释、 功能操作、客户服务和联系方式等。
9. 《维护手册》--包括产品简介、系统须知、初始环境设置、系 统配置、数据管理和备份、技术问题解答和联系方式等。
10. 《用户报告》--包括产品简介、购买时间、使用目的、使用时 间、使用地点、实施过程、出现问题和解决、产品总结和建议等。 11.《销售培训》--包括项目简介、产品功能、产品特点、商业优势、 系统运行环境、适用范围、目标客户等。
基础，进行详细的系统分析(产品的开发和实现方法)，估计开发期间需 要把什么问题说明白，程序员根据《系统分析》，开始在项目主管的带 领下进行编码。
6. 《数据库文档》--包括数据库名称、表名、字段名、字段类 型、字段说明、备注、字段数值计算公式等。以《系统分析》为基础， 进行详细的数据库设计。必要时可以用图表解说，特别是关系数据库。
第1章 实训目的与要求
1.1 实训目的
本实训要求学生通过具体的实例，模仿软件开发过程中软件文档写 作的具体方法和步骤，分组完成一套较为简单软件文档，具体要达到以 下几点目的。
1、了解软件开发周期各阶段的文档。 2、掌握各文档阐述的内容及作用。 3、了解文档所采用的国际、国家等相关标准。 4、了解各文档所涉及的软件知识。 5、掌握各文档采用的描述工具。 6、具体编写出2个主要的软件文件。
2．3 2．4 2．5 2．6 2．7 2．8 3 3．1 3．2
教育信息管理 再教育信息管理 工作经验信息管理 项目经验信息管理 技能信息管理 家庭成员信息管理 职位变更 职位空缺登记 简历信息
面试相关信息 领导审批 录用情况 推荐信息 推荐考核信息 调职记录信息 系统管理 部门管理 职位管理
Education ReEducation Experience Project Skill ReferPeople
5. 《技术白皮书》--以《技术分析》为书写基础，包括功能实 现、技术选型、关键技术问题的解决、技术方案特点、技术升级方向 等。
6. 《评测报告》--第三方权威评测报告。包括评测目的、评测范 围、评测环境、评测内容、实测数据、性能表现、结果分析和评测总结 等。
7. 《安装手册》--包括系统环境、运行平台、产品安装过程、初 始环境设置、安装记录等。
来进行详细设计。系统详细设计后容易扩展，降低对其他模块的耦合
性。详细设计要做到可操作性，使读者能清楚所要实现的功能，以及如
果去实现。粒度设计到方法。不具体设计到方法内的伪代码。
3.术语和缩写：
术语
描述性定义
Entity:
实体
DAL:
数据访问层
BLL：
业务逻辑层
User Profile:
用户的详细信息
Vacancy 同人事信息管理各模 块 Interview Interview JobHistory Recommendation PositionScore JobHistory
Department Position
3．3
密码修改
三、基本信息管理 （一）、表示层
User
图3.1 基本信息管理表示层
Reeducation:
再教育
Refer People:
家庭成员
Job History:
职位变更的历史记录
Recommendation:
推荐
二、软件模块标识：
编号 1 1．1 1．2
模块名称 人事信息管理
基本信息管理 详细信息管理
模块标识
User UserProfile
1．3 1．4 1．5 1．6 1．7 1．8 2 2．1 2．2
点、产品作用、适用范围、使用分析、功能模块、解决问题、合作伙 伴、成功案例等。一般用Power、point或者VCD录制软件实现。
3. 《疑问解答》--列出用户关心的问题和处理方法。用于解答软 件的操作功能和解决用户的疑难问题。
4. 《功能介绍》--以《需求分析》为书写基础，包括软件介绍、 软件结构、功能列表、功能描述和公司联系地址。
辽 宁 工 业大学
软件文档写作 实训报告
题目： 人力资源管理系统软件文档
院（
、
指导教师：
翟宝峰
教师职称：
副教授
起止时间： 2010.12.5-2010.12.11
院（系）、 研室
实训任务及评语
教研室：软件教
学号 、
实训题 目
学生姓名 、