软件文档写作实训报告(耀坤)人力资源管理

辽 宁 工 业 大 学 软件文档写作 实训报告题目： 人力资源管理系统软件文档 院（系）: 软件学院 专业班级： 软件技术081班 学 号： 学生姓名： 安凯辰 指导教师： 王彦华 教师职称： 助教 起止时间： 2010.11.22-2010.12.6 实训任务及评语院（系）：软件学院 教研室：软件教研室学 号学生姓名安凯辰专业班级软件技术081班实训题目 人力资源管理系统软件文档实训任务实训任务及要求：1、 了解软件开发周期各阶段的文档。2、 掌握各文档阐述的内容及作用。3、 了解文档所采用的国际、国家等相关标准。4、 了解各文档所涉及的软件知识。5、 掌握各文档采用的描述工具。6、 具体编写出2个主要的软件文档。实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。正确地完成上述内容，记录实习日记，规范完整地撰写出实训报告。几个人为一组完成一个相对完整的软件系统开发文档，组内成员编写的文档不能重复，文档要严格按照所采用的标准编写，图表布局要合理规范。指导教师评语及成绩成绩： 指导教师签字： 年 月 日辽 宁 工 业 大 学 综 合 实 训 说 明 书（论 文）目 录第1章 实训目的与要求11.1 实训目的11.2 实训的实验环境11.3 实训的预备知识11.4 实训要求1第2章 软件文档及其组成22.1软件文档的作用及分类22.2软件文档所采用的标准52.2 软件文档的主要内容5第3章 实 例73.1 人力资源管理系统数据库设计实例73.2人力资源管理系统操作手册实例13第4章 实训日记21第5章 实训总结22参考文献23第1章 实训目的与要求1.1 实训目的 本实训要求学生通过具体的实例，模仿软件开发过程中软件文档写作的具体方法和步骤，分组完成一套较为简单软件文档，具体要达到以下几点目的。1、了解软件开发周期各阶段的文档。2、掌握各文档阐述的内容及作用。3、了解文档所采用的国际、国家等相关标准。4、了解各文档所涉及的软件知识。5、掌握各文档采用的描述工具。6、具体编写出2个主要的软件文件。 1.2 实训的实验环境学校图书馆，互联网查询环境，具有软件图表制作软件的计算机。1.3 实训的预备知识 要求学生修完全部专科所有课程，具有较全面计算机软件知识和一定的文献检索能力及动手实践能力。该实训应安排在毕业设计之前进行。1.4 实训要求实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。正确地完成上述内容，记录实习日记，规范完整地撰写出实训报告。 第2章 软件文档及其组成2.1软件文档的作用及分类1. 软件文档的作用： 提高软件开发过程的能见度。把开发过程中发生的事件以某种可阅读的形式记录在文档中。管理人员可把这些记载下来的材料作为检查软件开发进度和开发质量的依据，实现对软件开发的工程管理。 提高开发效率。软件文档的编制，使得开发人员对各个阶段的工作都进行周密思考、全盘权衡、从而减少返工。并且可在开发早期发现错误和不一致性，便于及时加以纠正。 作为开发人员在一定阶段的工作成果和结束标志。 记录开发过程中的有关信息，便于协调以后的软件、开发、使用和维护。 提供对软件的运行、维护和培训的有关信息，便于管理人员、开发人员、操作人员、用户之间的协作、交流和了解。使软件开发活动更科学、更有成效。 便于潜在用户了解软件的功能、性能等各项指标，为他们选购符合自己需要的软件提供依据。文档在各类人员、计算机之间的多种桥梁作用中看出：既然软件已经从手工艺人的开发方式发展到工业化的生产方式，文档在开发过程中就起到关键作用，从某种意义上来说，文档是软件开发。规范的体现和指南。按规范要求生成一整套文档的过程，就是按照软件开发规范完成一个软件开发的过程。所以，在使用工程化的原理和方法来指导软件的开发和维护时，应当充分注意软件文档的编制和管理。2. 软件文档的分类：软件文档可以分为开发文档和产品文档两大类，如下图：软件文档开发文档产品文档功能要求需求分析技术分析系统分析数据库文档功能函数文档界面文档产品简介产品演示功能介绍技术白皮书使用手册用户手册维护手册图2-1软件文档分类图（1）、开发文档： 功能要求-来源于客户要求和市场调查，是软件开发中最早期的一个环节。客户提出一个模糊的功能概念，或者要求解决一个实际问题，或者参照同类软件的一个功能。有软件经验的客户还会提供比较详细的技术规范书，把他们的要求全部列表书写在文档中，必要时加以图表解说。这份文档是需求分析的基础。 需求分析-包括产品概述、主要概念、操作流程、功能列表和解说、注意事项、系统环境等。 技术分析-包括技术选型、开发人员、关键技术问题的解决、技术风险、技术升级方向等。以需求分析为基础，进行详细的技术分析，列出本项目需要使用什么技术方案，有哪些技术问题要解决 ，估计开发期间会碰到什么困难，技术方案以后如何升级，对本项目的技术有什么评价等。 系统分析-包括功能实现、模块组成、功能流程图、函数接口、数据字典、软件开发需要考虑的各种问题等。以需求分析为基础，进行详细的系统分析(产品的开发和实现方法)，程序员根据系统分析，开始在项目主管的带领下进行编码。 数据库文档-包括数据库名称、表名、字段名、字段类型、字段说明、备注、字段数值计算公式等。以系统分析为基础，进行详细的数据库设计。必要时可以用图表解说，特别是关系数据库。 功能函数文档-包括变量名、变量初植、功能，函数名，参数，如何调用、备注、注意事项等。以系统分析为基础，进行详细的说明，列出哪个功能涉及多少个函数，以便以后程序员修改、接手和扩展。 界面文档-包括软件外观、界面素材、编辑工具、文件名、菜单、按钮和其它界面部件的要求，这里与软件完成后的运行界面是一致的。 编译手册-包括服务器编译环境、操作系统、编译工具、GNU的C+编译器版本信息、目录说明、程序生成、源程序文件列表、Makefile配置及其相关程序的对应关系列表。 项目总结-包括项目简介、项目参与人员和开发时间、项目风险管理过程、项目功能列表、项目结构特点、技术特点、对项目的升级建议、对以后的项目的建议、人员素质情况等。（2）、产品文档： 产品简介-包括公司背景、产品概念、适用范围、产品功能、功能特点、运行要求和公司联系地址。 疑问解答-列出用户关心的问题和处理方法。用于解答软件的操作功能和解决用户的疑难问题。 功能介绍-以需求分析为书写基础，包括软件介绍、软件结构、功能列表、功能描述和公司联系地址。 技术白皮书-以技术分析为书写基础，包括功能实现、技术选型、关键技术问题的解决、技术方案特点、技术升级方向等。 评测报告-第三方权威评测报告。包括评测目的、评测范围、评测环境、评测内容、实测数据、性能表现、结果分析和评测总结等。 安装手册-包括系统环境、运行平台、产品安装过程、初始环境设置、安装记录等。 使用手册-包括产品简介、功能列表、功能描述和解释、功能操作、客户服务和联系方式等。 维护手册-包括产品简介、系统须知、初始环境设置、系统配置、数据管理和备份、技术问题解答和联系方式等。 用户报告-包括产品简介、购买时间、使用目的、使用时间、使用地点、实施过程、出现问题和解决、产品总结和建议等。2.2软件文档所采用的标准参照其它工程领域对工程标准划分的方法，软件工程标准主要有两种划分方法：按标准的类型划分和按标准的范围划分。一、按标准的类型划分：按标准的类型划分主要有过程标准、产品标准、行业标准、记法标准等。过程标准与开发一个产品或从事一项服务的一系列活动或操作有关。过程标准使用一组方法、工具和技术，给出“谁来做”、“做什么”、“如何做”、“何时做”、“何地做”及在软件工程活动中进行的不同层次工作的过程模型。产品标准则涉及软件工程事务的格式和内容。软件开发和维护活动文档化的结果就是软件产品，软件文档是软件工程活动进一步开展的基础。软件开发作为一种行业，其行业标准涉及软件工程的所有方面，如职业认证、职业培训、产品许可等。行业标准可以等同于行业行为规范。记法标准规定了在软件工程行业范围内，以唯一的方式进行交流的方法，如术语、表示法、语言等。它其实是一种语境规范。二、按标准的范围划分：按标准的范围划分主要是根据软件的任务功能和软件生存期进行比较、判定、评价和确定软件工程标准的范围和内容。任务功能可以表示软件工程过程，可以划分为产品工程功能、验证与确认功能以及技术管理功能3个部分。产品工程功能包括定义、生产和支持最终产品所必须的过程。验证和确认功能是检查产品质量的活动。技术管理功能是构造和控制产品工程的过程。这3个部分并不集中在单个的软件生存周期里，而是并行进行的生产、检查和控制活动。2.2 软件文档的主要内容此次所做的软件文档是人力资源管理系统软件文档。在此次人力资源管理系统软件文档编写包括人力资源管理系统操作手册、人力资源管理系统数据库设计说明书、人力资源管理系统概要设计说明书、人力资源管理系统用户手册、人力资源系统管理系统需求说明书、人力资源管理系统详细设计说明书、人力资源管理系统开发计划说明书、人力资源管理系统测试分析说明书等。人力资源管理系统（HRM）分为以下六大模块：人事管理、工资管理、职位变更管理、离职管理、培训管理、辅助系统，各模块的基本功能如下：1) 人事管理模块：包括人员档案、个人档案和部门机构的维护（人员的新增、修改、查看功能；个人档案的修改、查看功能，以及部门机构的新增、删除、修改、查看功能）。2) 工资管理模块：包括基本工资的设置；考勤、考核资料的导入；以及最终工资报表的查询和打印。3) 职位变更管理：包括职位空缺的维护（新增、删除、修改、查看、审核），应聘人员的登记、面试安排和考评；员工推荐的登记和考评；人事和领导的审批；调职记录的维护（新增、删除、修改、查看）。4) 离职管理模块：包括离职的申请、审批以及离职信息的维护。5) 培训管理模块：包括培训课程、培训讲师档案的维护；培训需求的维护（收集、审核）；以及培训课程的安排、培训考核和培训反馈的维护。6) 辅助系统模块：包括数据的备份、还原；员工的权限设置；个人密码修改；以及退出系统功能。第3章 实 例3.1 人力资源管理系统数据库设计实例3.1.1引言1编写目的编写本用户手册目的是为了帮助A公司管理人员以及测试人员了解人力资源管理系统（HRM）的数据库的基本构造，以便确保HRM系统顺利运行与正常维护。文档阅读对象：人力资源管理系统（HRM）管理员、测试人员。2背景数据库名称：应用系统名称：人力资源管理系统（HRM）人力资源管理系统（HRM）是A公司针对企业内部人力资源、薪金发放等人力资源管理业务出现的问题定制的。该系统应用于A公司计算机中心，主要应用于公司内部的查询与管理。3定义人力资源管理系统（HRM）4参考资料1郑人杰，殷人昆，陶永雷。实用软件工程（第二版）。北京：清华大学出版社，2金勇华，曲俊生。JAVA网络高级编程。北京：人民邮电出版社，2001。3唐学忠，费贤举。Visual Basic。中国电力出版社，20083.1.2外部设计1标识符和状态常数表consttable系统表cc界面信息表hr_interface雇员基本情况表A01学习简历表A02工作简历表 A03住房公积house_collected媒体信息代码表emp_info_code人员媒体信息表emp_logee_info工资表salary工资计算公式表formula考勤结果表check_result考勤扣款表check_money报表类型reporttype报表信息表reportinf2使用它的程序人员管理系统、招聘管理系统、培训管理系统、奖惩管理系统、薪酬管理系统、系统管理等人力资源管理系统中的各部分模块。3约定系统界面约定 ： 图3-1-1 管理窗口图图3-1-2 编辑窗口图4专门指导数据装载1）.完成了数据库定义后，还须装入各种实际数据；2）.由于数据的来源不同，其组织方式、结构、格式会不同，可能出现源数据与新数据库结构不相容；3）.我们可以先将源数据提取出来，存入计算机，然后分类转换，成为符合新数据库结构的数据，再存入数据库，具体步骤如下：筛选数据；转换数据格式；输入数据；校验数据。4）.为完成初始数据的录入，通常需要设计一些数据录入子系统，由计算机辅助完成入库工作，对某些纸质数据或数据量少的数据，可由人工一条条进行录入；而对于数据量大的数据，可考虑采用批量数据装载程序来实现。编写与调试应用程序只有当数据库的结构建立好后，才能开始应用程序的编写和调试；可使用模拟数据进行程序的调试。数据库的试运行应用程序调试完成并已有一小部分数据入库，就可以开始数据库的试运行，也称联合调试；试运行十分重要，因为：检测应用程序在接近真实的环境中运行是否符合设计要求；检测系统设计的性能和评价。试运行的工作主要有两个：功能测试：运行数据库应用程序，执行各种操作，测试程序是否满足设计要求，找出不足，改进现有程序直到符合设计要求；性能测试：测量系统的性能指标，分析是否符合设计目标。数据库的运行和维护数据库设计并试运行后，如试运行结果符合设计目标，数据库就可以真正投入运行了，同时也标志着开发任务的基本结束和维护工作的开始；维护工作包括：数据库的转储与恢复；数据库安全性和完整性控制；数据库性能的检测与改善；数据库的重组和重构。监控分析数据库的监控分析：指管理员借助相应工具在数据库运行过程中监测数据库系统的运行情况，掌握数据库当前或以往的负荷、配置、应用和其他相应信息，并对监测数据进行分析，分析数据库的性能参数和环境信息，评估系统的整体运行状态，为系统的安全运行和性能调优提供依据，并提出相应的改善措施，帮助管理人员尽早清除数据库的性能隐患。5支持软件人员管理：实现对员工信息进行全面管理的功能。招聘管理：实现企业的招聘信息、应聘信息的管理功能。培训管理：实现企业员工培训信息全程跟踪的功能。奖惩管理：员工薪酬信息管理。3.1.3结构设计1概念结构设计图3-1-3结构图2逻辑结构设计表3-1-1 用户表字段名数据类型长度是否主键描述idint4是数据库流水号usernamevarchar50用户名称passwordvarchar50用户密码sexbit1用户性别birthdaydatetime8用户出生年月日表3-1-2 奖惩表字段名数据类型长度是否主键描述Idint4是数据库流水号Namevarchar2000奖惩名称Reasonvarchar50奖惩原因explainvarchar50描述createtimedatetime8创建时间3物理结构设计人力资源管理系统是针对中小企业对现有员工和新聘员工的一个WEB管理平台。主页功能模块主要包括以下功能模块：人员管理：主要包括浏览人员信息、添加人员信息、人员信息的添加、人员信息的修改。招聘管理：主要包括应聘人员信息的详细查看、删除、添加以及信息入库。培训管理：主要包括培训计划的详细信息、信息删除、添加培训计划和填写培训总结。奖惩管理：主要包括奖惩详细信息、删除详细信息、添加详细信息、修改详细信息。薪金管理：主要包括薪金的修改、添加、删除。3.1.4运用设计1数据字典设计列名数据类型描述主键否外键为空否list_idnumber(18)序号tab_namevarchar(32)表名hr_syscollect.obj_idcol_namevarchar(32)列名col_china_namevarchar(32)中文名称col_flgvarchar(1)字段标志datatypevarchar(16)数据类型data_lenthinteger数据长度data_digitsinteger小数位数edit_lenthinteger编辑长度edit_digitsinteger编辑小数disp_orderinteger显示顺序code_flgvarchar(1)代码标志列名数据类型描述主键否外键为空否codetype_idvarchar(16)代码类名wf_codecollect.codetype_iddisp_colvarchar(32)显示字段data_colvarchar(32)值字段create_flgvarchar(1)创建标志disp_flgvarchar(1)显示创建pk_flgvarchar(1)关键字标志null_flgvarchar(1)为空标志col_aliasvarchar(32)指标项别名select_flgvarchar(1)必选项表3-1-3 属性表2安全保密设计系统管理员与数据库管理员必须为每级操作人员设置账号及口令，规定每一级操作人员的权限。页面权限：在安全保密方面，根据不同的员工设置了页面的访问权限（即正常显示和无权访问两种）。数据保密：由于涉及到数据敏感问题（例如工资、密码），防止被意外获取，对这些敏感数据进行了加密。3.2人力资源管理系统操作手册实例3.2.1引言1编写目的编写本用户手册目的是为了帮助A公司人员掌握如何使用人力资源管理系统（HRM），以便确保HRM系统顺利运行。文档阅读对象：人力资源管理系统（HRM）的用户、测试人员。2前景软件系统名称：人力资源管理系统（HRM）委托公司：A公司开发者：S公司系统描述：人力资源管理系统（HRM）是A公司针对企业内部人力资源、薪金发放等人力资源管理业务出现的问题定制的。该系统应用于A公司计算机中心，与其他各类管理软件联合应用。主要应用于公司内部的查询与管理。3定义HRM：Human Resource Management 人力资源管理系统4参考资料项目合同、工作任务陈述(SOW)、项目计划、系统需求说明书、概要设计说明书、详细设计说明书等实例进行参考。3.2.2软件征述1软件的结构人力资源管理系统人事管理工资管理职位变更管理离职管理培训管理辅助系统人员档案个人档案部门机构维护考勤与考核工资报表应聘信息管理在职信息管理申请与审批离职信息维护培训相关管理实现系统功能图3-2-1 人力资源管理系统总体结构图2程序表编 号模块名称模块标识1人事信息管理1.1基本信息管理User1.2详细信息管理UserProfile1.3教育信息管理Education1.4再教育信息管理ReEducation1.5工作经验信息管理Experience1.6项目经验信息管理Project1.7技能信息管理Skill1.8家庭成员信息管理ReferPeople2职位变更2.1职位空缺登记Vacancy2.2简历信息同人事信息管理各模块2.3面试相关信息Interview2.4领导审批Interview2.5录用情况JobHistory2.6推荐信息Recommendation2.7推荐考核信息PositionScore2.8调职记录信息JobHistory3系统管理3.1部门管理Department3.2职位管理Position3.3密码修改User表3-2-1 程序表3文卷表图3-2-2 文卷表3.2.3安装与初始化1.数据库安装1) 打开人力资源管理软件V4安装光盘2) 运行autorun.exe3) 选择“安装数据库”注：服务器必须数据库，客户端不需要安装数据库。2.软件安装 1) 打开人力资源管理软件V4安装光盘2) 运行autorun.exe3) 选择“安装人力资源管理软件V4”4) 按照安装向导步骤完成安装过程注：系统可能会要求安装MDAC（Microsoft Data Access Components）、Microsoft .NET Framework 1.1和Microsoft .NET Framework 语言套件，如果需要重新启动，请立即重新启动，重新启动后系统会自动继续安装。3.安装加密狗驱动1) 打开人力资源管理软件V4安装光盘2) 运行autorun.hta3) 选择“安装加密狗驱动程序”4) 选择 “驱动安装：USB狗驱动”点击“安装”按钮完成安装4.数据库配置1） 系统安装完毕，点击桌面快捷方式运行软件 2）如果是试用版，输入注册码，进入登录界面3）点击“配置数据库”，进入数据库配置界面4）如果是服务器端，第一次运行，点击“创建数据库”，系统自动创建数据库，按“确定”建立连接 5）如果是客户端，输入服务器名称，用户名和密码，按“确定”建立连接5.数据初始化1）删除测试数据2）建立组织结构 3）导入现有数据3.2.4运行说明1运行表于职工基本信息的录入、修改、查询、统计以及人事异动情况的一记录，并提供各类员工卡片、名册、统计报表。职工基本信息包括姓名、性别、身高、健康状况、身份证号码、文化水平、专业教育水平、工作经历、婚姻状况、家庭住址、联系方式等情况。建立绩效评估模块主要用于对员工工作职责和内容、工作绩效进行管理和评价，对绩效要素进行定量化，形成综合评价模型，为薪酬、奖惩、培训开发提供依据。2运行步骤HRM系统登录界面，包括输入用户名和密码，以及登录按钮。成功登录HRM系统后的主界面，分为顶部（公司LOGO或宣传栏），左部（HRM系统各项功能菜单），右部（内容主体部分）。数据显示列表，包含显示了数据的主要部分，以及新增、删除、修改和查看的链接功能。新增显示：根据要求，填写或选择内容，并提交数据；当然在未提交前可通过重置按钮进行重新录入。修改显示：根据要求，修改内容，并提交数据；当然在未提交前可通过重置按钮恢复原始数据。查看显示：只能查看信息，无法做任何修改，这对只有查看此功能的用户提供了更好的方式。而对于没有页面访问权限的用户，HRM系统提供了如下的提示：您没有访问权限。3运行1（标识符）说明(1)运行控制HRM系统登录界面，包括输入用户名和密码，以及登录按钮。成功登录HRM系统后的主界面，分为顶部（公司LOGO或宣传栏），左部（HRM系统各项功能菜单），右部（内容主体部分）。图3-2-3 数据显示图 数据显示列表，包含显示了数据的主要部分，以及新增、删除、修改和查看的链接功能。例如：上图为职位空缺列表的显示。 新增显示：根据要求，填写或选择内容，并提交数据；当然在未提交前可通过重置按钮进行重新录入。 删除显示：当点击某一删除链接时，将跳出信息提示对话框（确认是否删除）。以更为友好的界面、窗口和提示来与用户交互。(2)操作信息主要用于职工基本信息的录入、修改、查询、统计以及人事异动情况的一记录，并提供各类员工卡片、名册、统计报表。人力资源信息系统是组织进行有关人及人的工作方面的信息收集、保存、分析和报告的过程。计算机系统将实时记录员工基本情况、绩效表现、任职时间和流动状况等，每一个岗位的人员变动情况就变得一目了然。(3)输入一输出文卷数据背景输入数据输出数据数据来源键盘输入或鼠标选择数据库SQL SERVER 2005存储媒体无数据库SQL SERVER 2005出现频度高高限制无必须连接数据库表3-2-2 输入输出表(4)输出文段数据实例长度格式基准标号顺序分隔符10日期格式无Yyyy-mm-dd(年-月-日)-表3-2-3 输出文段表(5)输出文段的复制对于输出的要求是将计算机产生的输出利用A4纸打印并按装订线装订，并进行统一保存并进行标识，便于进行历史查询。(6)恢复过程序号可能出现的错误信息（截图、简单描述）错误分析解决措施11、 WEB服务管理软件损坏（iis等）；2、 网络不正常。1、 修复WEB服务管理软件；2、 查看网络连接是否正常。2点击某一链接（“退出”链接除外）时，页面跳转向HRM系统的登录界面用户登录超时。重新登录即可。表3-2-4 错误信息及恢复过程4运行2（标识符）说明HRM系统属于B/S模式，通过鼠标选择和键盘录入数据，通过Tab键可以依次选择供输入的文本框、供下拉的列表框和供点击的按钮。3.2.5非常规过程RM系统提供了数据的备份功能，允许对数据进行不定期的备份。当出现不可预料的毁灭性的数据破坏时，将可以使用“辅助系统”模块下的“数据管理”进行时间选择性的数据恢复。3.2.6远程操作可连接至广域网或局域网进行操作或者访问。第4章 实训日记时间实训任务第1天自由分组，选择题目。小组4个人选择的题目。第2-7天通过网络查寻大量关于人力资源管理系统软件工程文档的相关资料并且布置给每个组内成员相应的任务，分配了每个人设计文档说明书各部分，并且对每个文档要进行概要的设计和说明。第8-13天l 通过分组分配编写数据库设计说明和操作手册文档，首相了解软件工程文档作用及分类并将了解到的内容整理到报告中，并加强对软件文档编写的理解，掌握软件文档编写所采用的标准及分类及格式，整理编写软件文档主要内容到报告中。l 通过以上的学习接下来完成软件文档的编写，在编写过程中应该注意遵循标准的文档编写格式，使每一步都做到简明概要、一目了然，完成软件文档的编写。l 整理已经成型报告，补充不足、检查报告以及软件文档格式，整理文档，将软件文档以事例方式嵌入实训报告。第14天完成实训，提交