1、软件文档写作 人力资源管理系统辽 宁 工 业 大 学 软件文档写作 实训报告题目： 人力资源管理系统软件文档 院（系）: 软件学院 专业班级： 软件技术 班 学 号： 学生姓名： 指导教师： 王彦华 教师职称： 助 教 起止时间： 2010.11.22-2010.12.6 实训任务及评语院（系）：软件学院 教研室：软件教研室学 号 学生姓名 专业班级软件技术 班实训题目人力资源管理系统软件文档实训任务实训任务及要求：1、 了解软件开发周期各阶段的文档。2、 掌握各文档阐述的内容及作用。3、 了解文档所采用的国际、国家等相关标准。4、 了解各文档所涉及的软件知识。5、 掌握各文档采用的描述工具。
2、6、 具体编写出2个主要的软件文档。实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。正确地完成上述内容，记录实习日记，规范完整地撰写出实训报告。几个人为一组完成一个相对完整的软件系统开发文档，组内成员编写的文档不能重复，文档要严格按照所采用的标准编写，图表布局要合理规范。指导教师评语及成绩成绩： 指导教师签字： 年 月 日目 录第1章 实训目的与要求 11.1 实训目的 11.2 实训的实验环境 11.3 实训的预备知识 11.4 实训要求 1第2章 软件文档及其组成 22.1软件文档的作用及分类 22.2软件文档所采用的标准 32.3 软件文档的主要内容 3第3章 实 例 53.1
3、开发设计实例 53.2软件需求实例 11第4章 实训日记 18第5章 实训总结 19第1章 实训目的与要求1.1 实训目的 本实训要求学生通过具体的实例，模仿软件开发过程中软件文档写作的具体方法和步骤，分组完成一套较为简单软件文档，具体要达到以下几点目的。1、了解软件开发周期各阶段的文档。2、掌握各文档阐述的内容及作用。3、了解文档所采用的国际、国家等相关标准。4、了解各文档所涉及的软件知识。5、掌握各文档采用的描述工具。6、具体编写出2个主要的软件文件。 1.2 实训的实验环境学校图书馆，互联网查询环境，具有软件图表制作软件的计算机。1.3 实训的预备知识要求学生修完全部专科所有课程，具有较
4、全面计算机软件知识和一定的文献检索能力及动手实践能力。该实训应安排在毕业设计之前进行。1.4 实训要求实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。正确地完成上述内容，记录实习日记，规范完整地撰写出实训报告。 第2章 软件文档及其组成2.1软件文档的作用及分类软件文档的作用： 软件文档在软件开发中占有突出的地位和相当的工作量。高效率、高质量的开发、分发、管理和维护对转让、变更、修正、扩充和使用文档。对充分发挥软件产品的效益有着重要意义。软件文档的作用如下：1) 项目管理的依据。文档将通常“不可见的”软件开发进程转换成“可见的”文字资料，有利于项目的管理。2) 技术交流的语言。项目小
5、组内部、项目平行开发的各小组之间进行的交流和联系，通常都是通过文档来实现的。3) 项目质量保证。文档是进行项目质量审查和评价的重要依据，有效文档的提供，可以满足项目质量保证人员和审查人员的工作需要。4)支持培训与维护.合格的软件文档通常都提供有关软件运行、维护和培训的必要信息，支持软件产品的应用和维护。5)支持软件维护。软件文档提供系统开发的全部必要技术资料，有利于维护人员熟悉系统，开展维护工作；软件维护文档记载了软件维护过程中软件及其环境变化的全部信息。6) 记载软件历史。软件文档作为“记载软件历史的语言”，可用作未来项目的一种资源，向潜在用户报道软件的各种有利信息，便于他们判断自己是否需要
6、该软件提供的服务。良好的系统文档，显然有助于完成软件的移植，或将软件转移到各种新的系统环境中去。软件文档分类：从形式上来看，大致可分为两类： 1)是开发过程中填写的各种图表，可称之为工作表格。2)是应编制的技术资料或技术管理资料，可称之为文档或文件。 按照文档产生和使用的范围，软件文档大致可分为三类： 1)开发文档：这类文档是在软件开发过程中，作为软件开发人员前一阶段工作成果的体现和后一阶段工作依据的文档。包括软件需求说明书、数据要求说明书、概要设计说明书、详细设计说明书、可行性研究报告、项目开发计划。 2)管理文档：这类文档是在软件开发过程中，由软件开发人员制定的需提交人员的一砦工作计划或工
7、作报告。使管理人员能够通过这些文档了解软件开发项目安排、进度、资源使用和成果等。包括项目开发计划、测试计划、测试报告、开发进度月报及项目开发总结。 3)用户文档：这类文档是软件开发人员为用户准备的有关该软件使用、操作、维护的资料。包括用户手册、操作手册、数据要求说明书、软件需求说明书。2.2软件文档所采用的标准根据软件工程标准制定的机构和标准适用的范围，可分为5个层次：国际标准、国家标准、行业标准、企业(机构)标准、项目(课题)标准。ISO 9000标准概述：ISO 9000是国际标准化组织建立以来制订和公布的几千个标准中，影响最深远和普及最迅速的一个，其对各国经济生活所起的以下特点作用不可低
8、估。我们在观察这一现象时，注意到ISO 9000的以下几个特点：(1) 国际性。ISO 9000已成为各国对质量保证和质量管理制度的共同理解。(2) 完整性。ISO 9000系列标准包含了术语、质量保证、质量管理到支持件技术标准及实施指南等一整套共计20个标准，形成了一个完整的体系结构。(3) 兼容性。作为ISO 9000系列标准核心的三个质量保证标准是逐一包容的。即9001标准的内容最全面，9002标准排除了设计工作的质量要求，仅限于生产制造过程，9003标准仅限于检验和试验工作的质量要求。可以说，依次适用范围渐窄。(4) 主动性。选用和实施ISO 9000标准、建立质量体系的主体，是企业的
9、主动行为。(5) 可信性。ISO 9000的认证是授权认证机构对供方质量体系进行的独立、公正的活动，因此，具有相当的说服力和可信度。(6) 指导性。ISO 9000标准文本只是给出了质量管理和质量保证的原则，具体如何实施，需要供方结合自身机构的实际情况，特别是供方企业文化，进行创造性的解决。(7) 科学性。ISO 9000标准的背后是现代质量管理的科学原理。(8) 实践性。具体表现在，标准文本不是空洞的条文，并基于大量的质量管理实践。如标准可向前追溯，得知其源于英国国家标准和美国军用标准等。2.3软件文档的主要内容我所做的软件文档是人力资源管理系统软件文档。人力资源管理系统软件文档包括人力资源
10、管理系统操作手册、人力资源管理系统测试计划、人力资源管理系统概要设计说明书、人力资源管理系统可行性分析报告、人事信息系统管理系统需求说明书、人力资源管理系统详细设计说明书、人力资源管理系统项目计划、人力资源管理系统项目总结报告、人力资源管理系统用户手册。人力资源管理系统（HRM）分为以下六大模块：人事管理、工资管理、职位变更管理、离职管理、培训管理、辅助系统，各模块的基本功能如下：人事管理模块：包括人员档案、个人档案和部门机构的维护（人员的新增、修改、查看功能；个人档案的修改、查看功能，以及部门机构的新增、删除、修改、查看功能）。工资管理模块：包括基本工资的设置；考勤、考核资料的导入；以及最终
11、工资报表的查询和打印。职位变更管理：包括职位空缺的维护（新增、删除、修改、查看、审核），应聘人员的登记、面试安排和考评；员工推荐的登记和考评；人事和领导的审批；调职记录的维护（新增、删除、修改、查看）。离职管理模块：包括离职的申请、审批以及离职信息的维护。培训管理模块：包括培训课程、培训讲师档案的维护；培训需求的维护（收集、审核）；以及培训课程的安排、培训考核和培训反馈的维护。辅助系统模块：包括数据的备份、还原；员工的权限设置；个人密码修改；以及退出系统功能。第3章 实 例3.1 软件需求说明实例软件需求说明书1引言1.1编写目的随着企业的信息化和体制改革的步伐，人才竞争使企业的人力资源面临前
12、所未有的挑战。越来越多的企业不断地加大对员工的投资，从而更好地吸引、保留和发展所需要人才，是企业拥有持久的、强大的竞争优势。我们将为企业提供全面的人力资源管理解决方案，只在满足快速成长的企业管理信息化需求，主要目的就是帮助客户快速持续和健康成长，并且使人力资源部门借助此管理系统从重复烦杂的日常管理事务中解脱出来，将更多的精力投注于人力资源战略规划以支持和推动企业战略目标的实现，不断提升人力资源部对企业的价值，有效的提升企业的核心竞争力。本说明书目的在于明确说明系统需求，界定系统实现功能的范围，指导系统设计。本说明书的预期读者为：公司人力资源部人员，项目经理，系统分析员，系统设计人员，开发工程师
13、，测试经理以及测试设计人员等。1.2背景1)待开发的软件系统的名称：HRM人力资源管理系统。2)本项目的任务提出者：人事部管理人员。3)本项目的任务开发者：人力资源管理系统软件开发小组。1.3定义HRM：Personnel Information Management 人力资源管理系统。1.4参考资料1)软件工程概论 高等教育出版社 陶华亭等编著2任务概述2.1目标为了对与一定物力相结合的人力进行合理的培训、组织和调配，使人力、物力保持最佳比例，同时对人的思想、心理和行为进行恰当的诱导、控制和协调，充分发挥人的主观能动性，使人尽其才，事得其人，人事相宜，以实现组织目标，从而开发本款人力资源管理
14、系统。本软件主要提供企业人力资源部门人员一个实现组织目标和成员发展最大化的平台，是一项全部内容自含的独立的软件。2.2用户的特点本软件主要适用于各企业中人力资源管理部门人员，需要掌握基本的人力资源管理能力和基本用语。2.3假定和限制开发小组成员对于计算机方面知识有一定的掌握但是对于数据库方面的操作还有待提高。3需求规定3.1对功能的规定a.人员档案建立符合公司组织机构的组织模型和完整人事档案库，记录一定范围内的职工的档案信息，并且这些信息可以和绩效考核的成绩关联，方便存档和查询。系统重点围绕数据维护、查询和分析便捷的要求，并通过关键业务节点的业务流程化，提高HR业务的处理效率。图3.1 人力资
15、源系统图b.基本信息记录员工基本信息，包括人员ID、姓名、性别、年龄、学历、部门、职务、人员状态等相关信息。员工（在职、离职）基本信息的管理和维护，主要功能如下：提供员工基本信息的浏览；提供员工合同状况的查询；提供员工个人奖惩状况表（查询）；提供员工个人在公司人事调动状况表（查询）；在系统提供的标准人事信息基础上，用户可自行定义其他人事信息项目（即导向员工档案、员工合同、奖惩管理、个人登录密码修改等界面）。c.员工档案记录员工档案索引信息，包括人员ID、档案编号、档案名称、内容摘要、备注。对每个员工的档案进行维护（增加，删除，编辑）。d.员工合同提供标准的合同管理台帐，便于员工劳动合同的管理和
16、维护。主要信息包括：人员ID、合同编号、部门、岗位、合同开始时间、合同有效期、合同实际执行期、合同内容等。可以将公司相关协议纳入合同管理，如补充协议等。对员工合同按照时间排序，可以对每个员工合同信息进行增加、删除、编辑操作。可以按员工姓名、员工ID等信息查找员工的合同信息。e.奖惩管理可记录员工奖惩情况。主要信息包括：获奖人员ID，获奖人员姓名、获奖时间、奖惩内容等信息。对员工奖惩信息按照时间排序，可以对每个员工奖惩信息进行增加、删除和编辑操作。可以按照员工姓名、编号等信息查找员工。f.人事调配维护人事调动相关信息。并可以按各种条件查询相关信息。该模块权限仅为人力资源调配人员所有。主要信息包括
17、：调配人员ID、调配人员姓名、变动时间、变动前状态、变动后状态、变动类别等。变动类别种类如下：人事调动管理；针对人事调动（部门间调入、调出）、晋升、降职等人士变动业务的处理和查询；根据职工定员、缺员信息及员工职称信息，对员工岗位进行调配；确定员工职称信息，根据教育培训成绩聘任员工职称；解除员工职称；新进员工。对于新进员工的相应信息，系统根据用户输入的信息自动进行增加处理，并提示相应专责同步处理。离退员工：用户可根据实际情况，检查系统中每个在职人员的年龄，列出符合退休标准的人员，作为人员退休的参考。针对员工离职，记录其离职类型和时间，便于日后的分析处理一边进一步提出相关对策。 提供离职人员各种信
18、息的查询。g.教育培训满足公司对员工在职培训及学历教育等多种形式的培训模式，通过信息平台进行教育培训档案的建立、修改维护；培训信息发布等工作。h.培训类别维护对教育培训项目类别维护。包括类别编码、名称等信息。可以增加、删除、修改教育培训的类别信息。i.培训记录对教育培训记录进行维护。主要内容包括：培训类别、培训编号、培训名称、培训时间（开始、结束时间）、参加人员、考核成绩等信息。k.系统管理 系统管理员进行后台管理的模块，包括组织管理、安全控制。l.用户管理 对使用本系统的用户进行维护，维护信息包括用户名、密码、用户状态等。用户登录时要首先判断用户的合法性，只有合法用户才能操作相应的功能界面。
19、可以对用户进行增加、修改、删除等操作。m.角色管理 系统中采用角色的概念来建立用户与对应功能的关系。一个角色可以对应多个功能界面，当赋予用户某一角色后，该用户即可操作所赋角色所对应的功能界面。可以对角色进行增加、修改、删除等操作。3.2对性能的规定3.2.1精度在运行此软件时候，若输入数据时文本类型的数据，则其精度要求为最精度的数据；若输出数据时整型或长整形类型，则其精度要求为保留小数点后一位。例如：输入的基本信息中应包括：姓名（字符串）性别（布尔值）身份证号（字符串）登记日期（字符串）退房日期（字符串）其他信息（字符）3.2.2时间特性要求响应时间：0.2S更新处理时间：0.1S数据的转换和
20、传送时间：1S解题时间等的要求：1S3.2.3灵活性此软件可以适应所有的微软版本的操作系统；同时支持多种方式对数据的输入；以及各种操作指令的运用；此外软件与绝大多数软件可以兼容支持大部分的数据库打印机的软硬件。 3.3输入输出要求根据文本框提示要求进行输入、输出，并需符合一定文本规范。3.4数据管理能力要求需要管理的文卷和记录的个数按客户需要可以调整初步规定上限为五千条记录。3.5安全性能要求用户账户分系统账户和普通用户账户；系统账户可以更改所有用户信息以及系统的日常维护，普通用户只可以浏览与更改自己的信息。3.6其他专门要求无。4运行环境规定4.1设备网络环境：可在已建立的局域网和全国广域网
21、框架上运行，基于以TCP/IP传输协议为基础的数据联网模式。数据库服务器：SqlServer2008服务器操作系统平台：WIN2000 SERVER/WIN2003 1G内存客户机：Win2000 Professional/WIN2000 SERVER/WINXP/WIN2003，800X600分辨率及以上，256M以上内存。4.2支持软件服务器:WIN2000 SERVER/WIN2003客户机: Win2000 Professional/WIN2000 SERVER/WINXP/WIN2003 WIN7 VISTA.数据库: SqlServer2008.4.3接口本系统有两个外部接口：1、
22、银行接口，主要提供员工银行账户。2、考勤接口，利用ICE公司原有的打卡机的接口。本系统有一个内部接口:1、简历接口，主要提供外部提交的简历信息。5费用估算人员成本12000，差旅费500，设备折旧1500，培训700其他1100，合计总共大概需要15800。6尚待解决的问题本系统在处理用户非法输入时，在该阶段还没有具体提出解决方案，在接下来设计时会着重考虑以完善系统。3.2开发计划实例开发计划（GB856788）1引言1.1编写目的编写目的：阐明编写本文档的目的，指出读者对象。编写本用户手册目的是为了帮助人员掌握如何使用人力资源管理系统（HRM），以便确保HRM系统顺利运行。文档阅读对象：人力
23、资源管理系统（HRM）的用户、测试人员。1.2背景1)待开发的软件系统的名称：人力资源管理系统。2)本项目的任务提出者：人事部管理人员。3)本项目的任务开发者：人力资源管理系统软件开发小组。1.3定义HRM：Human Resource Management 人力资源管理系统1.4参考资料1)软件工程概论 高等教育出版社 陶华亭等编著2项目概述2.1产品2.1.1程序1.程序概况人事信息、薪金发放等人力资源管理业务是在日常生产过程中非常重要的环节，原来基本上采用手工处理方式进行操作，造成工作效率低、处理速度慢、人工计算薪金准确率较低的情况。因此开发人力资源管理子系统，通过在该系统中的相关数据录
24、入、参数设置，使用电脑保存职工档案资料、计算薪资发放以及记录职工参加培训、职位变更等的详细资料，代替原来的手工处理工作，方便进行人事信息、薪金资源的查询，大幅度提高工作效率和管理水平。2.功能描述人事信息、薪金发放等人资管理业务是在日常生产过程中非常重要的环节，原来基本上采用手工处理方式进行操作，造成工作效率低、处理速度慢、人工计算薪金准确率较低的情况。因此开发人力资源管理子系统，通过在该系统中的相关数据录入、参数设置，使用电脑保存职工档案资料、计算薪资发放以及记录职工参加培训、职位变更等的详细资料，代替原来的手工处理工作，方便进行人事信息、薪金资源的查询，大幅度提高工作效率和管理水平。人力资
25、源管理系统（HRM）分为以下六大模块：人事管理、工资管理、职位变更管理、离职管理、培训管理、辅助系统，各模块的基本功能如下：人事管理模块：包括人员档案、个人档案和部门机构的维护（人员的新增、修改、查看功能；个人档案的修改、查看功能，以及部门机构的新增、删除、修改、查看功能）。图2-1 人员管理图工资管理模块：包括基本工资的设置；考勤、考核资料的导入；以及最终工资报表的查询和打印。图2-2 工资管理图职位变更管理：包括职位空缺的维护（新增、删除、修改、查看、审核），应聘人员的登记、面试安排和考评；员工推荐的登记和考评；人事和领导的审批；调职记录的维护（新增、删除、修改、查看）。离职管理模块：包括
26、离职的申请、审批以及离职信息的维护。培训管理模块：包括培训课程、培训讲师档案的维护；培训需求的维护（收集、审核）；以及培训课程的安排、培训考核和培训反馈的维护。图2-3 人员培训图辅助系统模块：包括数据的备份、还原；员工的权限设置；个人密码修改；以及退出系统功能。2.1.2文件用户手册与操作手册需要交给用户。主要内容是描述该系统的基本操作与功能。2.1.3服务在初次交付系统时提供培训用户安装在购买许可有效期限内提供维护与升级以及各种技术相关问题的咨询。2.1.4非移交产品 包括软件需求、开发计划、概要设计、数据库设计、详细设计与测试分析文档都不需要移交给用户。2.2验收标准对于两个文档核查是否
27、有遗漏项目，对于软件系统进行检测是否能正确事先规定功能要求。2.3项目完成最迟期限2010年12月6号。3实施计划3.1接口人员负责本项目的数据库所有接口都由姚琨负责。包括:负责本项目同用户的接口；负责本项目同本单位各管理机构，如财务部门、质量管理部门等的接口；以及负责本项目同各分合同负责单位的接口。3.2进度安排先进行项目开发计划和软件需求，写出来文档后再进行编写概要设计与用户手册文档随后再编写数据库设计与操作手册文档最后再编写详细设计与测试分析文档。3.3预算表3.3-2 预算表类型数量（元）阶段阶段1阶段2阶段3阶段4合计人员成本100020004000500012000差旅费20010
28、0100100500设备折旧 -5005005001500培训 -100100500700其它2002002005001100合计1400290049006600158003.4关键问题1.数据库的链接，如果设计的不好整个系统就会成为一个空壳子，没有数据。2.接口的设计，与其他系统连接的主要凭借。3.5专题计划需要制定安全保密计划要保证软件的信息的保密工作，也要制定质量保证计划，要保证软件系统的质量。4支持条件4.1计算机系统支持4.1.1开发环境1.硬件环境表4.1.1 硬件环境表WEB服务器机器类型硬件配置台式PC、笔记本电脑CPU 奔腾IV 1.6G，内存 256M以上，硬盘10G以上，
29、网络适配器（以不同方式接入网络，例如：LAN, WAN, Internet/Intranet）客户端机器类型硬件配置台式PC、笔记本电脑一般配置即可，另网络适配器（以不同方式接入网络，例如：LAN, WAN, Internet/Intranet），显示器800*6002软件环境表4.1.2 软件环境表WEB服务器操作系统其他应用软件Windows 2003 Enterprise Server.Net Framework2.0客户端操作系统其他应用软件Windows系列操作系统IE6.0或以上4.1.2运行环境要求同4.1.1 4.2需有用户承担的工作人事信息的一些基本信息的输入需有用户自己完成
30、，需要在正式启用软件系统之前完成，软件系统的安装也需要由用户自己独立完成；此外用户需要提供适合软件系统运行的软硬件环境。4.3由外单位提供的条件对于软件系统的批量生产需要有外单位完成要在正式投入市场之前完成。5项目开发计划表登记号：121项目开发计划表项目名称人力资源管理系统项目编号111填写人王寿强阶段号任务编号任务状态前序任务作业人员开始时间结束时间提交成果评审机构评审时间REQREQ01N王寿强11.2211.23软件需求说明书HRM开发小组11.24REQREQ02NREQ01王寿强11.2311.24开发计划说明书HRM开发小组11.24DESDES01NREQ02孙德富11.2411.26概要设计说明书HRM开发小组11.29DESDES02NDES01苏博11.2611.28详细设计说明书HRM开发小组12.02IMPIMP 01NDES02孙德富11.2811.29用户手册HRM开发小组11.29IMPIMP02NIMP 01姚琨
