软件文档写作实训报告-人力资源管理系统.doc

辽 宁 工 业 大 学 软件文档写作 实训报告题目： 人力资源管理系统 院（系）: 软件学院 专业班级： 软件工程 102班 学 号： 学生姓名： 指导教师： 教师职称： 副教授 起止时间： 2011.12.5-2011.12.11 实训任务及评语院（系）：软件学院 教研室：软件教研室学 号101301204学生姓名专业班级软件工程102实训题目 人力资源管理系统实训任务实训任务及要求：1、 了解软件开发周期各阶段的文档。2、 掌握各文档阐述的内容及作用。3、 了解文档所采用的国际、国家等相关标准。4、 了解各文档所涉及的软件知识。5、 掌握各文档采用的描述工具。6、 具体编写出2个主要的软件文档。实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。正确地完成上述内容，记录实习日记，规范完整地撰写出实训报告。几个人为一组完成一个相对完整的软件系统开发文档，组内成员编写的文档不能重复，文档要严格按照所采用的标准编写，图表布局要合理规范。指导教师评语及成绩成绩： 指导教师签字： 年 月 日辽 宁 工 业 大 学 综 合 实 训 说 明 书（论 文）目 录第1章 实训目的与要求11.1 实训目的11.2 实训的实验环境11.3 实训的预备知识11.4 实训要求1第2章 软件文档及其组成22.1软件文档的作用及分类22.2软件文档所采用的标准42.3 软件文档的主要内容4第3章 实 例63.1 人力资源管理系统详细设计说明书实例63.2人力资源管理系统用户手册实例11第4章 实训日记15第5章 实训总结16参考文献17第1章 实训目的与要求1.1 实训目的 本实训要求学生通过具体的实例，模仿软件开发过程中软件文档写作的具体方法和步骤，分组完成一套较为简单软件文档，具体要达到以下几点目的。1、了解软件开发周期各阶段的文档。2、掌握各文档阐述的内容及作用。3、了解文档所采用的国际、国家等相关标准。4、了解各文档所涉及的软件知识。5、掌握各文档采用的描述工具。6、具体编写出2个主要的软件文件。 1.2 实训的实验环境学校图书馆，互联网查询环境，具有软件图表制作软件的计算机。1.3 实训的预备知识 要求学生修完全部专科所有课程，具有较全面计算机软件知识和一定的文献检索能力及动手实践能力。该实训应安排在毕业设计之前进行。1.4 实训要求实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。正确地完成上述内容，记录实习日记，规范完整地撰写出实训报告。第2章 软件文档及其组成2.1软件文档的作用及分类 文档是计算机软件产品的重要组成部分，没有文档就不成其为软件，也更不能成为软件产品。软件文档是一种重要的软件工程技术资料。如系统分析文档、设计文档、版本说明文档软件文档的规范编制，在软件开发工作中占有突出的地位和相当大的工作量。高质量、高效率的编制、分发、管理、维护文档，及时的变更、修正、扩充和使用文档，对于软件产品的设计开发、发行使用、变更维护、转让移植、二次开发等，对于充分发挥软件产品的效益，都有着重要的意义。基于软件生存期方法，可以从形式上将软件文档大致分成两类：软件开发过程中需要填写的各种图表，及应编制的各种技术文件或管理资料。软件文档根据其产生和使用的范围，主要划分为3大类：开发文档、用户文档和管理文档。一、开发文档： 1.1 功能要求-来源于客户要求和市场调查，是软件开发中最早期的一个环节。客户提出一个模糊的功能概念，或者要求解决一个实际问题，或者参照同类软件的一个功能。有软件经验的客户还会提供比较详细的技术规范书，把他们的要求全部列表书写在文档中，必要时加以图表解说。这份文档是需求分析的基础。1.2 投标方案-根据用户的功能要求，经过与招标方沟通和确认。1.3.需求分析-包括产品概述、主要概念、操作流程、功能列表和解说、注意事项、系统环境等。1.4 技术分析-包括技术选型、技术比较、开发人员、关键技术问题的解决、技术风险、技术升级方向、技术方案评价，竞争对手技术分析等。以需求分析为基础，进行详细的技术分析，列出本项目需要使用什么技术方案，有哪些技术问题要解决 ，估计开发期间会碰到什么困难，技术方案以后如何升级，对本项目的技术有什么评价等。1.5.系统分析-包括功能实现、模块组成、功能流程图、函数接口、数据字典、软件开发需要考虑的各种问题等。以需求分析为基础，进行详细的系统分析(产品的开发和实现方法)，估计开发期间需要把什么问题说明白，程序员根据系统分析，开始在项目主管的带领下进行编码。 1.6.数据库文档-包括数据库名称、表名、字段名、字段类型、字段说明、备注、字段数值计算公式等。以系统分析为基础，进行详细的数据库设计。必要时可以用图表解说，特别是关系数据库。1.7.功能函数文档-包括变量名、变量初植、功能，函数名，参数，如何调用、备注、注意事项等。以系统分析为基础，进行详细的说明，列出哪个功能涉及多少个函数，以便以后程序员修改、接手和扩展。1.8.界面文档-包括软件外观、界面素材、编辑工具、文件名、菜单、按钮和其它界面部件的要求，这里与软件完成后的运行界面是一致的。 1.9 编译手册-包括服务器编译环境、操作系统、编译工具、gnu的c+编译器版本信息、目录说明、程序生成、源程序文件列表、makefile配置及其相关程序的对应关系列表。1.10 qa文档-包括产品简介、产品原理、产品功能列表、功能描述、功能流程、执行结果、数据库结构、测试要求等，提供给软件测试人员使用。 1.11 项目总结-包括项目简介、项目参与人员和开发时间、项目风险管理过程、项目功能列表、项目结构特点、技术特点、对项目的升级建议、对以后的项目的建议、人员素质情况等。二、用户文档：2.1 产品简介-包括公司背景、产品概念、适用范围、产品功能、功能特点、运行要求和公司联系地址。2.2 产品演示-包括公司简介、产品背景、产品描述、产品特点、产品作用、适用范围、使用分析、功能模块、解决问题、合作伙伴、成功案例等。一般用power、point或者vcd录制软件实现。2.3 疑问解答-列出用户关心的问题和处理方法。用于解答软件的操作功能和解决用户的疑难问题。 2.4 功能介绍-以需求分析为书写基础，包括软件介绍、软件结构、功能列表、功能描述和公司联系地址。2.5 技术白皮书-以技术分析为书写基础，包括功能实现、技术选型、关键技术问题的解决、技术方案特点、技术升级方向等。2.6 评测报告-第三方权威评测报告。包括评测目的、评测范围、评测环境、评测内容、实测数据、性能表现、结果分析和评测总结等。三、管理文档：3.1 安装手册-包括系统环境、运行平台、产品安装过程、初始环境设置、安装记录等。3.2 使用手册-包括产品简介、功能列表、功能描述和解释、功能操作、客户服务和联系方式等。3.3 维护手册-包括产品简介、系统须知、初始环境设置、系统配置、数据管理和备份、技术问题解答和联系方式等。3.4 用户报告-包括产品简介、购买时间、使用目的、使用时间、使用地点、实施过程、出现问题和解决、产品总结和建议等。3.5销售培训-包括项目简介、产品功能、产品特点、商业优势、系统运行环境、适用范围、目标客户等。2.2软件文档所采用的标准参照其它工程领域对工程标准划分的方法，软件工程标准主要有两种划分方法：按标准的类型划分和按标准的范围划分。2.2.1按标准的类型划分：按标准的类型划分主要有过程标准、产品标准、行业标准、记法标准等。过程标准与开发一个产品或从事一项服务的一系列活动或操作有关。过程标准使用一组方法、工具和技术，给出“谁来做”、“做什么”、“如何做”、“何时做”、“何地做”及在软件工程活动中进行的不同层次工作的过程模型。产品标准则涉及软件工程事务的格式和内容。软件开发和维护活动文档化的结果就是软件产品，软件文档是软件工程活动进一步开展的基础。软件开发作为一种行业，其行业标准涉及软件工程的所有方面，如职业认证、职业培训、产品许可等。行业标准可以等同于行业行为规范。记法标准规定了在软件工程行业范围内，以唯一的方式进行交流的方法，如术语、表示法、语言等。它其实是一种语境规范。2.2.2按标准的范围划分：按标准的范围划分主要是根据软件的任务功能和软件生存期进行比较、判定、评价和确定软件工程标准的范围和内容。任务功能可以表示软件工程过程，可以划分为产品工程功能、验证与确认功能以及技术管理功能3个部分。产品工程功能包括定义、生产和支持最终产品所必须的过程。验证和确认功能是检查产品质量的活动。技术管理功能是构造和控制产品工程的过程。这3个部分并不集中在单个的软件生存周期里，而是并行进行的生产、检查和控制活动。2.3 软件文档的主要内容我所做的软件文档是人力资源管理系统软件文档。人力资源管理系统软件文档包括人力资源管理系统操作手册、人力资源管理系统测试计划、人力资源管理系统概要设计说明书、人力资源管理系统可行性分析报告、人力资源系统管理系统需求说明书、人力资源管理系统详细设计说明书、人力资源管理系统项目计划、人力资源管理系统项目总结报告、人力资源管理系统用户手册。人力资源管理系统（hrm）分为以下六大模块：人事管理、工资管理、职位变更管理、离职管理、培训管理、辅助系统，各模块的基本功能如下：人事管理模块：包括人员档案、个人档案和部门机构的维护（人员的新增、修改、查看功能；个人档案的修改、查看功能，以及部门机构的新增、删除、修改、查看功能）。工资管理模块：包括基本工资的设置；考勤、考核资料的导入；以及最终工资报表的查询和打印。职位变更管理：包括职位空缺的维护（新增、删除、修改、查看、审核），应聘人员的登记、面试安排和考评；员工推荐的登记和考评；人事和领导的审批；调职记录的维护（新增、删除、修改、查看）。离职管理模块：包括离职的申请、审批以及离职信息的维护。培训管理模块：包括培训课程、培训讲师档案的维护；培训需求的维护（收集、审核）；以及培训课程的安排、培训考核和培训反馈的维护。辅助系统模块：包括数据的备份、还原；员工的权限设置；个人密码修改；以及退出系统功能。第3章 实 例3.1 人力资源管理系统详细设计说明书实例人力资源管理系统测试分析，采用的是（gb856888）标准。一、引言1.1编写目的：本概要设计是根据用户需求说明书和系统需求说明编写，提供给详细设计参考。本概要设计的读者包括项目经理，需求分析员，设计人员，以及开发人员。当然也包括测试人员。1.2项目背景：系统名称：hrm人力资源管理系统开发者：mark、michael、robin、luke1.3定义：详细设计的原则和方法：项目整体结构清晰，按照概要设计的结构来进行详细设计。系统详细设计后容易扩展，降低对其他模块的耦合性。详细设计要做到可操作性，使读者能清楚所要实现的功能，以及去实现。粒度设计到方法。不具体设计到方法内的伪代码。1.4参考资料：吴东强 实用软件工程技术 电子工业出版社 2006.6张应辉 软件工程技术 北京航空航天大学出版社 2008.1二、总体设计2.1需求规定本文挡提供给开发人员进行开发参考，以及测试人员编写单元测试所用。2.2运行环境开发人员利用vs 2005 team suite来开发，服务器安装sql 2005 和team foundation server。2.3基本设计概念和处理流程系统主要利用vs 2005的n-tiers的设计思想。对系统进行分层设计。主要采用mvc的架构模式。系统分成三层：数据访问层、业务逻辑层、ui层。数据访问层主要对数据库数据进行操作，包括增加数据，修改数据和删除数据。业务逻辑层基于数据访问层之上，它主要针对业务流程来实现系统的功能。ui表现层把业务逻辑表现在web页面上，以完成人力资源管理系统所要完成的功能。2.4结构2.4.1基本信息表 图2.4.1 基本信息管理表示层2.4.2业务逻辑层功能描述：对用户基本信息进行管理模块编号：1.1模块功能：对用户的基本信息的操作和维护，包括：增加用户基本信息，修改用户的基本信息，查询用户的基本信息，删除用户模块名称：userbiz命名空间：microlink.hrm.userbiz处理：对用户基本信息的增加，修改，查询用户或列表属性功能：获取和设置user实体 名称：user方式：get & set返回值：user处理过程：无函数和过程1、添加用户过程功能： 添加一个系统用户过程名称：adduser参数说明：无返回值：bool是否成功处理过程：首先读取配置的初始密码，如果没有配置初始密码，则赋给它“123456”。然后通过数据层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加密，看是否和数据库数据匹配。匹配通过后，加载用户信息，否则退出。三、接口设计3.1外部借口 银行接口，主要提供员工银行账户。考勤接口，利用comm公司原有的打卡机的接口。3.2内部接口简历接口，主要提供外部提交的简历信息。四、运行设计4.1运行模块组合网络环境：可在已建立的局域网和全国广域网框架上运行，基于以tcp/ip传输协议为基础的数据联网模式。4.2运行控制数据库服务器：sqlserver2005服务器操作系统平台：win2000 server/win2003 1g内存客户机：win2000 professional/win2000 server/winxp/win2003，800x600分辨率及以上，256m以上内存。五、系统数据结构设计5.1物理结构设计标识：common_config构件名称：applicationconfiguration功能：应用程序配置输入：配置文件，例如web.config输出：相关配置的字符串，例如connstring信息：这个构件主要功能是应用程序配置文件中读取相应的配置信息。标识：common_log构件名称：applicaionlog功能：日志记录输入：日志的信息，报告错误信息，异常信息，跟踪信息等输出：日志文件信息：主要是记录应用程序的状态，用来跟踪应用呈现，包括错误，异常，和重要信息等。用户可以通过查看日志文件来了解系统的运行状态。标识：common_exception构件名称：applicationexception功能：异常处理输入：异常信息输出：记录异常文件信息：主要是对应用程序出现以外的运行时错误，即异常时，进行相应的处理，并把异常信息和处理结果写如异常记录文件中。3.2人力资源管理系统用户手册实例人力资源管理系统测试分析，采用的是（gb856888）标准。一、引言11编写目的：编写本用户手册目的是为了帮助comm贸易公司人员掌握如何使用人力资源管理系统（hrm），以便确保hrm系统顺利运行。文档阅读对象：人力资源管理系统（hrm）的用户、测试人员。1.2项目背景：系统名称：hrm人力资源管理系统开发者：mark、michael、robin、luke1.3定义： hrm：human resource management 人力资源管理系统。1.4参考资料: 肖刚 实用软件文档写作 清华大学出版社 2008.6刘冰 软件工程实践教程机械工业出版社 2009.1二、软件用途2.1功能： 列出本软件系统所具备的基本功能，并加以概述。人力资源管理系统（hrm）分为以下六大模块：人事管理、工资管理、职位变更管理、离职管理、培训管理、辅助系统，各模块的基本功能如下：人事管理模块：包括人员档案、个人档案和部门机构的维护（人员的新增、修改、查看功能；个人档案的修改、查看功能，以及部门机构的新增、删除、修改、查看功能）。工资管理模块：包括基本工资的设置；考勤、考核资料的导入；以及最终工资报表的查询和打印。职位变更管理：包括职位空缺的维护（新增、删除、修改、查看、审核），应聘人员的登记、面试安排和考评；员工推荐的登记和考评；人事和领导的审批；调职记录的维护（新增、删除、修改、查看）。离职管理模块：包括离职的申请、审批以及离职信息的维护。培训管理模块：包括培训课程、培训讲师档案的维护；培训需求的维护（收集、审核）；以及培训课程的安排、培训考核和培训反馈的维护。辅助系统模块：包括数据的备份、还原；员工的权限设置；个人密码修改；以及退出系统功能。2.2性能：2.2.1数据精确度逐项说明输入、输出及处理数据的精度。公共说明：根据数据的有效性，针对不同的信息定义了不同的数据输入要求、预期输出结果以及数据精确度。例如：类型输入输出数据精度170170数字格式，精度为32.2.2时间特性如响应时间、处理时间、数据传输时间和转换时间等。响应时间：页面首次访问响应时间为5s，非首次访问响应时间为3s；处理时间：页面处理时间为3s；数据传输时间和转换时间：页面数据传输时间和转换时间为3s；注：考虑到设备、环境的问题（如：计算机性能、网络带宽等），其时间特性有所不同。这里我们以正常、稳定的设备、环境为准。2.2.3适应性说明当操作方式、运行环境发生某些变化时，本软件的适应能力。服务器端：须安装有web服务管理软件（例如iis），dotnet framework2.0框架组件，否则将无法运行该系统。客户端：拥有浏览器（例如：ie）并支持页面脚本（例如：javascript），即可浏览该系统，反之，则无法浏览该系统。2.3安全保密说明该软件在安全保密方面的设计考虑和实际达到的能力。页面权限：在安全保密方面，根据不同的员工设置了页面的访问权限（即正常显示和无权访问两种）。数据保密：由于涉及到数据敏感问题（例如工资、密码），防止被意外获取，对这些敏感数据进行了加密。三、运行环境3.1硬件环境列出本软件系统运行时所需的硬件最小配置，如a.计算机型号、主存容量；b.外存储器、媒体、记录格式、设备型号及数量；c. 输入、输出设备；d.数据传输设备及数据转换设备的型号及数量；e.网络环境描述。最低硬件要求：web服务器机器类型硬件配置台式pc、笔记本电脑cpu 奔腾iv 1.6g，内存 256m以上，硬盘10g以上，网络适配器（以不同方式接入网络，例如：lan, wan, internet/intranet）客户端机器类型硬件配置台式pc、笔记本电脑一般配置即可，另网络适配器（以不同方式接入网络，例如：lan, wan, internet/intranet），显示器800*6003.2软件环境最低软件要求：web服务器操作系统其他应用软件windows 2003 enterprise server.net framework2.0客户端操作系统其他应用软件windows系列操作系统ie6.0或以上3.3数据结构列出为支持本软件的运行所需要的数据库和数据文卷等。四、使用过程4.1安装准备说明本软件系统的存储形式及数量、需要的环境变量设置、初始化数据等。hrm系统为b/s模式，将安装在应用程序服务器上，以.apsx等文件类型的形式存储，无须设置环境变量和初始化数据。如图：图4.1 hrm环境变量和初始数据安装步骤一步步列出本软件系统的详细安装步骤，包括数据库系统的安装,应用服务器的安装,应用系统的安装等。由于本hrm系统的安装过程简单易懂，只须按照安装提示，一步步安装本hrm系统。初始化设置说明本软件系统安装后为保证正常运行而需要进行的相关系统设置、数据初始化等。在hrm系统安装过程中已经对系统进行了相关设置和数据初始化，因此无须另外设置和初始化。4.2输入规定输入数据和参量的准备要求4.2.1输入数据的实现背景说明输入数据的现实背景，主要是：1情况：例如人员变动，库存缺货；2情况出现的频度：例如是周期性的，随机性的，一项操作状态的函数；3情况来源：例如：认识部门，仓库管理部门；4输入媒体：例如键盘，穿孔卡片，磁带；5限制：出于安全保密考虑而对访问这些数据所加的限制；6质量管理：例如对输入数据合理性的检验以及当输入数据有误时应采取的措施，如建立出错情况记录等；7支配：例如如何确定输入数据是保留还是废弃，是否分配给其他的接受者等。4.2.2输入格式说明对初始输入数据和参量的格式要求，如：长度，格式基准，标号，顺序，标点，词汇表，省略和重复，控制。4.2.3输入举例为每个完整的输入形式提供样本，包括：控制和首部，主题，尾部，省略，重复。4.3输出对每项输出做出说明4.3.1输出数据的现实背景主要是，使用，使用频度，媒体，质量管理，支配。4.3.2输出格式首部：如输出数据标识符，输出日期和输出编号。主体：输出信息的主体，包括分栏标题。尾部：包括累计总数，结束标记。4.3.3输出举例 为每种输出类型提供例子。对例子中的每一项，说明：定义每项输出信息的意义和用途； 来源是从特定的输入中抽出、从数据库文卷中取出、或从软件的计算过程中得到； 特性输出的值域、计量单位、在什么情况下可缺省等。4.4文卷调查这一条的编写针对具有查询能力的软件，内容包括：同数据库查询有关的初始化、准备、及处理所需 要的详细规定，说明查询的能力、方式，所使用的命令和所要求的控制规定。 第4章 实训日记第1天：自由分组，选择题目。我们小组4个人选择的题目是人力资源管理系统。第2-5天：去网上查阅了大量关于人力资源管理系统软件工程文档的相关资料并查找了一些关于软件工程设计的资料，并且布置给每个组内成员相应的任务，分配了每个人设计文档说明书各部分，并且要对每个细节要进行全面的设计和说明。第5-9天：整理从网上收集来的资料和程序代码，分析模块功能，阅读软件工程书籍，对软件工程文档的撰写有了一定了解， 了解对软件工程文档作用及分类并对其中内容整理到报告中，了解软件工程文档所采用的标准及分类并对内容整理到报告中，整理软件工程文档主要内容到报告中，完成报告实例一，对其中遇到的问题记录下来，然后通过从网上查资料找答案和大家共同研究探索解决，再完成实例一之后用同样的方式按部就班的进行着实例二的编写，再完成实例二之后，通过2周的实训，完成实训总结内容，总结这2周的收获。第10天：完成人力资源管理系统软件工程文档报告，上交作品。第5章 实训总结通过这次课设让我们明白了很多，人力资源管理系统能够使得管理者快速高效地完成企业日常事务中的人事工作，降低了人力资源管理成本，使管理者能