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

辽 宁 工 业 大 学 软件文档写作 实训报告题目： 人力资源管理系统软件文档 院（系）: 软件学院 专业班级： 软件技术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软件文档所采用的标准32.2 软件文档的主要内容4第3章实 例53.1 详细设计实例53.2 测试分析实例15第4章实训日记17第5章实训总结18第1章 实训目的与要求1.1 实训目的 本实训要求学生通过具体的实例，模仿软件开发过程中软件文档写作的具体方法和步骤，分组完成一套较为简单软件文档，具体要达到以下几点目的。1、了解软件开发周期各阶段的文档。2、掌握各文档阐述的内容及作用。3、了解文档所采用的国际、国家等相关标准。4、了解各文档所涉及的软件知识。5、掌握各文档采用的描述工具。6、具体编写出2个主要的软件文件。 1.2 实训的实验环境学校图书馆，互联网查询环境，具有软件图表制作软件的计算机。1.3 实训的预备知识 要求学生修完全部专科所有课程，具有较全面计算机软件知识和一定的文献检索能力及动手实践能力。该实训应安排在毕业设计之前进行。1.4 实训要求实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。正确地完成上述内容，记录实习日记，规范完整地撰写出实训报告。 第2章 软件文档及其组成2.1软件文档的作用及分类软件文档(document)也称文件，通常指的是一些记录的数据和数据媒体，它具有固定不变的形式，可被人和计算机阅读。它和计算机程序共同构成了能完成特定功能的计算机软件(有人把源程序也当作文档的一部分)。我们知道，硬件产品和产品资料在整个生产过程中都是有形可见的，软件生产则有很大不同，文档本身就是软件产品。没有文档的软件，不成其为软件，更谈不到软件产品。软件文档的编制在软件开发工作中占有突出的地位和相当的工作量。在软件的生产过程中，总是伴随着大量的信息要记录、要使用。因此，软件文档在产品的开发生产过程中起着重要的作用： 1).提高软件开发过程的能见度。把开发过程中发生的事件以某种可阅读的形式记录在文档中。管理人员可把这些记载下来的材料作为检查软件开发进度和开发质量的依据，实现对软件开发的工程管理。2)提高开发效率。软件文档的编制，使得开发人员对各个阶段的工作都进行周密思考、全盘权衡、从而减少返工。并且可在开发早期发现错误和不一致性，便于及时加以纠正。3)作为开发人员在一定阶段的工作成果和结束标志。 4)记录开发过程中的有关信息，便于协调以后的软件、开发、使用和维护。 5)提供对软件的运行、维护和培训的有关信息，便于管理人员、开发人员、操作人员、用户之间的协作、交流和了解。使软件开发活动更科学、更有成效。 6)便于潜在用户了解软件的功能、性能等各项指标，为他们选购符合自己需要的软件提供依据。 文档在软件开发人员、软件管理人员、维护人员、用户以及计算机之间的多种桥梁作用。软件开发人员在各个阶段中以文档作为前阶段工作成果的体现和后阶段工作的依 据，这个作用是显而易见的。我们称此为开发文档。软件开发过程中软件开发人员需制定一些工作计划或工作报告，这些计划和报告都要提供给管理人员， 并得到必要的支持。管理人员则可通过这些文档了解软件开发项 目安排、进度、资源使用和成果等。我们称这些文档为管理文档。软件开发人员需为用户了解软件的使用、操作和维护提供详细的资料，我们称此为用户文档。以上三种文档构成了软件文档的主要部分。详细构成如图2.1所示：文档用户文档用户手册操作手册维护修改建议软件需求（规格）说明书开发文档软件需求（规格）说明书数据要求说明书概要设计说明书详细设计说明书可行性研究报告项目开发计划管理文档项目开发计划测试计划测试报告开发进度月报开发总结报告图2.1详细构成图2.2软件文档所采用的标准参照其它工程领域对工程标准划分的方法，软件工程标准主要有两种划分方法：按标准的类型划分和按标准的范围划分。一、按标准的类型划分：按标准的类型划分主要有过程标准、产品标准、行业标准、记法标准等。过程标准与开发一个产品或从事一项服务的一系列活动或操作有关。过程标准使用一组方法、工具和技术，给出“谁来做”、“做什么”、“如何做”、“何时做”、“何地做”及在软件工程活动中进行的不同层次工作的过程模型。产品标准则涉及软件工程事务的格式和内容。软件开发和维护活动文档化的结果就是软件产品，软件文档是软件工程活动进一步开展的基础。软件开发作为一种行业，其行业标准涉及软件工程的所有方面，如职业认证、职业培训、产品许可等。行业标准可以等同于行业行为规范。记法标准规定了在软件工程行业范围内，以唯一的方式进行交流的方法，如术语、表示法、语言等。它其实是一种语境规范。二、按标准的范围划分：按标准的范围划分主要是根据软件的任务功能和软件生存期进行比较、判定、评价和确定软件工程标准的范围和内容。任务功能可以表示软件工程过程，可以划分为产品工程功能、验证与确认功能以及技术管理功能3个部分。产品工程功能包括定义、生产和支持最终产品所必须的过程。验证和确认功能是检查产品质量的活动。技术管理功能是构造和控制产品工程的过程。这3个部分并不集中在单个的软件生存周期里，而是并行进行的生产、检查和控制活动。2.2 软件文档的主要内容我所做的软件文档是人力资源管理系统软件文档。人力资源管理系统软件文档包括人力资源管理系统操作手册、人力资源管理系统测试计划、人力资源管理系统概要设计说明书、人力资源管理系统可行性分析报告、人力资源系统管理系统需求说明书、人力资源管理系统详细设计说明书、人力资源管理系统项目计划、人力资源管理系统项目总结报告、人力资源管理系统用户手册。人力资源管理系统（HRM）分为以下六大模块：人事管理、工资管理、职位变更管理、离职管理、培训管理、辅助系统，各模块的基本功能如下：人事管理模块：包括人员档案、个人档案和部门机构的维护（人员的新增、修改、查看功能；个人档案的修改、查看功能，以及部门机构的新增、删除、修改、查看功能）。工资管理模块：包括基本工资的设置；考勤、考核资料的导入；以及最终工资报表的查询和打印。职位变更管理：包括职位空缺的维护（新增、删除、修改、查看、审核），应聘人员的登记、面试安排和考评；员工推荐的登记和考评；人事和领导的审批；调职记录的维护（新增、删除、修改、查看）。离职管理模块：包括离职的申请、审批以及离职信息的维护。培训管理模块：包括培训课程、培训讲师档案的维护；培训需求的维护（收集、审核）；以及培训课程的安排、培训考核和培训反馈的维护。辅助系统模块：包括数据的备份、还原；员工的权限设置；个人密码修改；以及退出系统功能。 第3章 实 例3.1详细设计实例一、概述1.编写目的：本文挡提供给开发人员进行开发参考，以及测试人员编写单元测试所用。2.项目背景：系统名称：人力资源管理系统开发者：苏博，王寿强，孙德福，姚坤详细设计的原则和方法：项目整体结构清晰，按照概要设计的结构来进行详细设计。系统详细设计后容易扩展，降低对其他模块的耦合性。详细设计要做到可操作性，使读者能清楚所要实现的功能，以及如果去实现。粒度设计到方法。不具体设计到方法内的伪代码。3.术语和缩写：术语 描述性定义Entity: 实体DAL: 数据访问层BLL： 业务逻辑层User Profile: 用户的详细信息Reeducation: 再教育Refer People: 家庭成员Job History: 职位变更的历史记录Recommendation: 推荐二、软件模块标识，如表3.1所示：编 号模 块 名 称模 块 标 识1人事信息管理11 基本信息管理User12 详细信息管理UserProfile13 教育信息管理Education14 再教育信息管理ReEducation15 工作经验信息管理Experience16 项目经验信息管理Project17 技能信息管理Skill18 家庭成员信息管理ReferPeople2职位变更 21 职位空缺登记Vacancy22 简历信息同人事信息管理各模块23 面试相关信息Interview24 领导审批Interview25 录用情况JobHistory26 推荐信息Recommendation27 推荐考核信息PositionScore28 调职记录信息JobHistory3系统管理31 部门管理Department32 职位管理Position33 密码修改User表3.1软件模块标识三、基本信息管理（一）、表示层，如图3.1图3.1 基本信息管理表示层（二）、业务逻辑层功能描述：对用户基本信息进行管理模块编号：1.1模块功能：对用户的基本信息的操作和维护，包括：增加用户基本信息，修改用户的基本信息，查询用户的基本信息，删除用户模块名称：UserBiz命名空间：Microlink.HRM.UserBiz处理：对用户基本信息的增加，修改，查询用户或列表属性功能：获取和设置User实体 名称：User方式：Get & Set返回值：User处理过程：无函数和过程1、添加用户过程功能： 添加一个系统用户过程名称：AddUser参数说明：无返回值：bool是否成功处理过程：首先读取配置的初始密码，如果没有配置初始密码，则赋给它“”。然后通过数据层Insert记录。2、删除用户过程功能：修改用户的状态为离职状态过程名称：DeleteUser参数说明：无返回值：bool是否成功处理过程：修改员工的状态为离职状态，调用ChangeUserInfo修改其状态。3、修改用户过程功能：修改用户的信息过程名称：ChangeUserInfo参数说明：无返回值：bool是否成功处理过程：通过修改实体信息，再通过用户编号ID把实体信息Update到数据库中。4、获取某一用户过程功能：通过ID获取某一用户过程名称：GetUser参数说明：long ID用户编号返回值：User处理过程：以用户编号为参数，调用数据层的Load(ID)来获取用户实体，并返回用户实体5、获取所有用户过程功能：获取所有用户过程名称：GetAllUsers参数说明：无返回值：DataTable 包含所有用户的列表处理过程：通过数据层的LoadAll获取所有用户的数据集，提取其中的Users表。6、用户登录过程功能：通过用户和密码登录系统过程名称：Login参数说明：string userName用户名String password密码Sring logIP登录IP返回值：bool看是否验证通过处理过程：对密码进行MD5加密，看是否和数据库数据匹配。匹配通过后，加载用户信息，否则退出。（三）、数据访问层功能描述：对用户基本信息进行管理模块编号：1.1模块功能：对用户的基本信息的操作和维护，包括：增加用户基本信息，修改用户的基本信息，查询用户的基本信息，删除用户模块名称：UserDAL命名空间：Microlink.HRM.UserDAL处理：用户基本信息的增加，修改，查询用户或列表，以及验证用户等数据库操作1、插入用户记录过程功能： 插入一条用户记录过程名称：Insert参数说明：User userEntity用户实体返回值：bool 是否操作成功处理过程：把实体的值赋给存储过程NewUser参数，操作存储过程完成2、修改用户记录过程功能： 修改一条用户记录过程名称：Update参数说明：User userEntity用户实体返回值：bool 是否操作成功处理过程：从数据库提取的实体，经过修改后的提交到存储过程UpdateUser进行修改。3、获取用户过程功能： 获取一条用户记录过程名称：Load参数说明：long userID返回值：User处理过程：通过编号作为参数来调用存储过程GetUser来获取单用户信息。4、获取所有用户过程功能： 获取所有用户记录过程名称：LoadAll参数说明：无返回值：DataSet处理过程：调用存储过程GetAllUser，通过查询语句返回所有用户表5、获取所有用户的联系信息过程功能： 获取所有用户记录的联系信息过程名称：LoadAddressList参数说明：无返回值：DataSet处理过程：通过GetAddressList的存储过程来查询所有用户的联系信息。包括的联系信息有：EmailAddress, MobilePhone,UserProfile.PhsPhone, OtherPhone四、详细信息管理（一）、表示层，如图3.2所示：图3.2详细信息管理（二）、业务逻辑层功能描述：对用户详细信息进行业务管理模块编号：1.2模块功能：对用户的详细信息的操作和维护，包括：增加用户详细信息，修改用户的详细信息，查询用户的详细信息等模块名称：UserProfileBiz命名空间：Microlink.HRM.UserProfileBiz处理：用户详细信息的增加，修改，查询等操作属性：功能：获取和设置UserProfile实体名称：UserProfile方式：Get & Set返回值：UserProfile处理过程：无功能：获取和设置员工的教育信息名称：Education方式：Get & Set返回值：DataTable处理过程：无功能：获取和设置家庭成员名称：ReferPeople方式：Get & Set返回值：DataTable处理过程：无功能：获取和设置工作经验名称：Experience方式：Get & Set返回值：DataTable处理过程：无功能：获取和设置项目经验名称：Project方式：Get & Set返回值：Project处理过程：无功能：获取和设置再教育信息名称：ReEducation方式：Get & Set返回值：DataTable处理过程：无功能：获取和设置员工的数据集，包括家庭成员，教育，再教育，项目经验，工作经验。参考LoadUserInfo名称：UserInfo方式：Get & Set返回值：DataSet处理过程：无函数和过程：1、获取员工有关的列表信息过程功能：包括获取家庭成员，教育，再教育，项目经验，工作经验列表过程名称：LoadUserInfo参数说明：long userID编号返回值：bool是否成功处理过程：如果userID为0 则返回，否则通过DAL各自加载家庭成员，教育，再教育，项目经验，工作经验的DataTable到UserInfo的数据集中。1、 添加员工详细信息过程功能：添加UserProfile 过程名称：AddUserProfile参数说明：无返回值：bool是否成功处理过程：通过数据层来insert实体UserProfile2、修改员工详细信息过程功能：修改员工详细的信息过程名称：ChangeUserProfile参数说明：无返回值：bool是否成功处理过程：通过数据层来Update员工修改的详细信息（三）、实体层，如图3.3所示：图3.3实体层（四）、数据访问层功能描述：对用户详细信息进行管理模块编号：1.2模块功能：对用户的详细信息的操作和维护，包括：增加用户基本信息，修改用户的基本信息，查询用户的基本信息模块名称：UserProfileDAL命名空间：Microlink.HRM.UserProfileDAL处理：用户详细信息的增加，修改，查询用户操作1、插入用户详细信息记录过程功能： 插入一条用户详细信息记录过程名称：Insert参数说明：UserProfile userProfileEntity用户实体返回值：bool 是否操作成功处理过程：把实体的值赋给存储过程AddUserProfile参数，操作存储过程完成2、修改用户记录过程功能： 修改一条用户记录过程名称：Update参数说明：UserProfile userProfileEntity用户实体返回值：bool 是否操作成功处理过程：从数据库提取的实体，经过修改后的提交到存储过程SetUserProfile进行修改。3、获取用户过程功能： 获取一条用户记录过程名称：Load参数说明：long userID返回值：UserProfile处理过程：通过编号作为参数来调用存储过程GetUserProfile来获取单用户信息。3.2 测试分析实例一概述1编写目的：为了能以最少的人力和是发现潜在的各种错误和缺陷。系统测试是保证系统质量和可靠性的关键步骤，是对系统开开过程的系统分析，系统设计和实施的最后检查。2.项目背景：系统名称：人力资源管理系统开发者：苏博，王寿强，孙德福，姚坤CPU：pIV 2.6G 硬盘：80G内存：256M操作系统：windows XP软件开发环境：Visual Basic6.0、sqlserver 2000其它辅助软件：Microsoft office 2000, Photoshop7.0等测试环境：与实际运行环境 之间可能存在的差异以及这些差异对测试结果的影响。二测试概要： 1系统登陆测试用例：功能特性：正确验证系统角色用户，正常进入系统进行操作测试目的：对输入的用户名、密码、验证码进行合法性检查。预置条件：注册用户名:苏博密码：9999角色：苏博如表3.4所示：用例说明输入数据预期结果实际结果测试结果不输入信息输入为空, 其它为预置条件提示请输入用户名和密码或用户名密码无效用户名密码无效正确随便输入一个用户名和密码户名:杨家华密码：19987 提示请输入用户名和密码或用户名密码无效用户名密码无效正确只输入用户名用户名: 苏博它为预置条件输入密码无效输入密码无效正确只输入密码密码:9999它为预置条件输入用户名无效输入用户名或密码无效错误输入用户名和密码用户名:苏博密码：9999登录成功登录成功正确表3.1三.对软件功能的结论 功能（系统登陆测试）：如用户名和密码输入不正确，会出现什么情况。输入用户名和密码都正确，看是否能登陆。第4章 实训日记时间实训任务第1天自由分组，选择题目。小组4个人选择的题目。第2-7天通过网络查寻大量关于人力资源管理系统软件工程文档的相关资料并且布置给每个组内成员相应的任务，分配了每个人设计文档说明书各部分，并且对每个文档要进行概要的设计和说明。第8-13天通过分组分配编写设计说明和软件测试文档，首相了解软件工程文档作用及分类并将了解到的内容整理到报告中，并加强对软件文档编写的理解，掌握软件文档编写所采用的标准及分类及格式，整理编写软件文档主要内容到报告中。通过以上的学习接下来完成软件文档的编写，在编写过程中应该注意遵循标准的文档编写格式，使每一步都做到简明概要、一目了然，完成软件文档的编写。理已经成型报告，补充不足、检查报告以及软件文档格式，整理文档，将软件文档以事例方式嵌入实训报告。第14天完成实训，提交文档与报告第5章 实训总结人力资源管理系统能够使得管理者快速高效地完成企业日常事务中的人事工作，降低了人力资源管理成本，使管理者能集中精力在企业战略目标；