资源描述
<p><span id="_baidu_bookmark_start_0" style="display: none; line-height: 0px;"></span>辽 宁 工 业 大 学
软件文档写作 实训报告
题目： 人力资源管理系统软件文档
院（系）： 软件学院
专业班级： 电子商务092班
学 号：
学生姓名： 杨丽娟
指引教师： 张莉莉
教师职称： 助 教
起止时间： .11.28-.12.03
实训任务及评语
院（系）：软件学院 教研室：软件教研室
学 号
学生姓名
杨丽娟
专业班级
电子商务092班
实训题目
人力资源管理系统软件文档
实训任务
实训任务及规定：
1、 理解软件开发周期各阶段文档。
2、 掌握各文档阐述内容及作用。
3、 理解文档所采用国际、国家等有关原则。
4、 理解各文档所涉及软件知识。
5、 掌握各文档采用描述工具。
6、 详细编写出2个重要软件文档。
实训过程中，要严格遵守实训时间安排，听从指引教师指引。对的地完毕上述内容，记录实习日记，规范完整地撰写出实训报告。
几种人为一组完毕一种相对完整软件系统开发文档，组内成员编写文档不能重复，文档要严格按照所采用原则编写，图表布局要合理规范。
指引教师评语及成绩
成绩： 指引教师签字：
12月 03日
目 录
第1章 实训目与规定 1
1.1 实训目 1
1.2 实训实验环境 1
1.3 实训预备知识 1
1.4 实训规定 1
第2章 软件文档及其构成 2
2.1软件文档作用及分类 2
2.2软件文档所采用原则 4
2.2 软件文档重要内容 4
第3章 实 例 6
3.1 人力资源管理系统详细设计阐明书实例 6
第4章 实训日记 13
第5章 实训总结 14
参照文献 15
第1章 实训目与规定
1.1 实训目
本实训规定学生通过详细实例，模仿软件开发过程中软件文档写作详细办法和环节，分组完毕一套较为简朴软件文档，详细要达到如下几点目。
1、理解软件开发周期各阶段文档。
2、掌握各文档阐述内容及作用。
3、理解文档所采用国际、国家等有关原则。
4、理解各文档所涉及软件知识。
5、掌握各文档采用描述工具。
6、详细编写出2个重要软件文献。
1.2 实训实验环境
学校图书馆，互联网查询环境，具备软件图表制作软件计算机。
1.3 实训预备知识
规定学生修完所有专科所有课程，具备较全面计算机软件知识和一定文献检索能力及动手实践能力。该实训应安排在毕业设计之迈进行。
1.4 实训规定
实训过程中，要严格遵守实训时间安排，听从指引教师指引。对的地完毕上述内容，记录实习日记，规范完整地撰写出实训报告。
第2章 软件文档及其构成
2.1软件文档作用及分类
软件文档可以分为开发文档和产品文档两大类。
开发文档涉及：《功能规定》、《投标方案》、《需求分析》、《技术分析》、《系统分析》、《数据库文档》、《功能函数文档》、《界面文档》、《编译手册》、《QA文档》、《项目总结》等。
产品文档涉及：《产品简介》、《产品演示》、《疑问解答》、《功能简介》、《技术白皮书》、《评测报告》、《安装手册》、《使用手册》、《维护手册》、《顾客报告》、《销售培训》等。
一、开发文档：
1. 《功能规定》--来源于客户规定和市场调查，是软件开发中最初期一种环节。客户提出一种模糊功能概念，或者规定解决一种实际问题，或者参照同类软件一种功能。有软件经验客户还会提供比较详细技术规范书，把她们规定所有列表书写在文档中，必要时加以图表解说。这份文档是需求分析基本。
2. 《投标方案》--依照顾客功能规定，通过与招标方沟通和确认。
3. 《需求分析》--涉及产品概述、重要概念、操作流程、功能列表和解说、注意事项、系统环境等。
4. 《技术分析》--涉及技术选型、技术比较、开发人员、核心技术问题解决、技术风险、技术升级方向、技术方案评价，竞争对手技术分析等。以《需求分析》为基本，进行详细技术分析，列出本项目需要使用什么技术方案，有哪些技术问题要解决 ，预计开发期间会遇到什么困难，技术方案后来如何升级，对本项目技术有什么评价等。
5. 《系统分析》--涉及功能实现、模块构成、功能流程图、函数接口、数据字典、软件开发需要考虑各种问题等。以《需求分析》为基本，进行详细系统分析(产品开发和实现办法)，预计开发期间需要把什么问题阐明白，程序员依照《系统分析》，开始在项目主管带领下进行编码。
6. 《数据库文档》--涉及数据库名称、表名、字段名、字段类型、字段阐明、备注、字段数值计算公式等。以《系统分析》为基本，进行详细数据库设计。必要时可以用图表解说，特别是关系数据库。
7. 《功能函数文档》--涉及变量名、变量初植、功能，函数名，参数，如何调用、备注、注意事项等。以《系统分析》为基本，进行详细阐明，列出哪个功能涉及多少个函数，以便后来程序员修改、接手和扩展。
8. 《界面文档》--涉及软件外观、界面素材、编辑工具、文献名、菜单、按钮和其他界面部件规定，这里与软件完毕后运营界面是一致。
9. 《编译手册》--涉及服务器编译环境、操作系统、编译工具、GNUC++编译器版本信息、目录阐明、程序生成、源程序文献列表、Makefile配备及其有关程序相应关系列表。
10. 《QA文档》--涉及产品简介、产品原理、产品功能列表、功能描述、功能流程、执行成果、数据库构造、测试规定等，提供应软件测试人员使用。
11. 《项目总结》--涉及项目简介、项目参加人员和开发时间、项目风险管理过程、项目功能列表、项目构造特点、技术特点、对项目升级建议、对后来项目建议、人员素质状况等。
二、产品文档：
1. 《产品简介》--涉及公司背景、产品概念、合用范畴、产品功能、功能特点、运营规定和公司联系地址。
2. 《产品演示》--涉及公司简介、产品背景、产品描述、产品特点、产品作用、合用范畴、使用分析、功能模块、解决问题、合伙伙伴、成功案例等。普通用Power、point或者VCD录制软件实现。
3. 《疑问解答》--列出顾客关怀问题和解决办法。用于解答软件操作功能和解决顾客疑难问题。
4. 《功能简介》--以《需求分析》为书写基本，涉及软件简介、软件构造、功能列表、功能描述和公司联系地址。
5. 《技术白皮书》--以《技术分析》为书写基本，涉及功能实现、技术选型、核心技术问题解决、技术方案特点、技术升级方向等。
6. 《评测报告》--第三方权威评测报告。涉及评测目、评测范畴、评测环境、评测内容、实测数据、性能体现、成果分析和评测总结等。
7. 《安装手册》--涉及系统环境、运营平台、产品安装过程、初始环境设立、安装记录等。
8. 《使用手册》--涉及产品简介、功能列表、功能描述和解释、功能操作、客户服务和联系方式等。
9. 《维护手册》--涉及产品简介、系统须知、初始环境设立、系统配备、数据管理和备份、技术问题解答和联系方式等。
10. 《顾客报告》--涉及产品简介、购买时间、使用目、使用时间、使用地点、实行过程、浮现问题和解决、产品总结和建议等。
11.《销售培训》--涉及项目简介、产品功能、产品特点、商业优势、系统运营环境、合用范畴、目的客户等。
2.2软件文档所采用原则
参照其他工程领域对工程原则划分办法，软件工程原则重要有两种划分办法：按原则类型划分和按原则范畴划分。
一、按原则类型划分：
按原则类型划分重要有过程原则、产品原则、行业原则、记法原则等。过程原则与开发一种产品或从事一项服务一系列活动或操作关于。过程原则使用一组办法、工具和技术，给出“谁来做”、“做什么”、“如何做”、“何时做”、“何地做”及在软件工程活动中进行不同层次工作过程模型。产品原则则涉及软件工程事务格式和内容。软件开发和维护活动文档化成果就是软件产品，软件文档是软件工程活动进一步开展基本。软件开发作为一种行业，其行业原则涉及软件工程所有方面，如职业认证、职业培训、产品允许等。行业原则可以等同于行业行为规范。记法原则规定了在软件工程行业范畴内，以唯一方式进行交流办法，如术语、表达法、语言等。它其实是一种语境规范。
二、按原则范畴划分：
按原则范畴划分重要是依照软件任务功能和软件生存期进行比较、鉴定、评价和拟定软件工程原则范畴和内容。任务功能可以表达软件工程过程，可以划分为产品工程功能、验证与确认功能以及技术管理功能3个某些。产品工程功能涉及定义、生产和支持最后产品所必要过程。验证和确认功能是检查产品质量活动。技术管理功能是构造和控制产品工程过程。这3个某些并不集中在单个软件生存周期里，而是并行进行生产、检查和控制活动。
2.3 软件文档重要内容
我所做软件文档是人力资源管理系统软件文档。人力资源管理系统软件文档涉及人力资源管理系统操作手册、人力资源管理系统测试筹划、人力资源管理系统概要设计阐明书、人力资源管理系统可行性分析报告、人力资源系统管理系统需求阐明书、人力资源管理系统详细设计阐明书、人力资源管理系统项目筹划、人力资源管理系统项目总结报告、人力资源管理系统顾客手册。
人力资源管理系统（HRM）分为如下六大模块：人事管理、工资管理、职位变更管理、离职管理、培训管理、辅助系统，各模块基本功能如下：
人事管理模块：涉及人员档案、个人档案和部门机构维护（人员新增、修改、查看功能；个人档案修改、查看功能，以及部门机构新增、删除、修改、查看功能）。
工资管理模块：涉及基本工资设立；考勤、考核资料导入；以及最后工资报表查询和打印。
职位变更管理：涉及职位空缺维护（新增、删除、修改、查看、审核），应聘人员登记、面试安排和考核；员工推荐登记和考核；人事和领导审批；调职记录维护（新增、删除、修改、查看）。
离职管理模块：涉及离职申请、审批以及离职信息维护。
培训管理模块：涉及培训课程、培训讲师档案维护；培训需求维护（收集、审核）；以及培训课程安排、培训考核和培训反馈维护。
辅助系统模块：涉及数据备份、还原；员工权限设立；个人密码修改；以及退出系统功能。
第3章 实 例
3.1 人力资源管理系统详细设计阐明说实例
1 引言
1.1 目
本文挡阐明编写本文档目，提供应开发人员进行开发参照，以及测试人员编写单元测试所用，协助Comm贸易公司人员掌握如何使用人力资源管理系统（HRM），以便保证HRM系统顺利运营。
1.2 背景
系统名称：HRM人力资源管理系统
详细设计原则和办法：项目整体构造清晰，按照概要设计构造来进行详细设计。系统详细设计后容易扩展，减少对其她模块耦合性。详细设计要做到可操作性，使读者能清晰所要实现功能，以及如果去实现。粒度设计到办法。不详细设计到办法内伪代码。可涉及：a.本软件项目委托单位、开发单位和主管部门；b.本软件系统与其他系统关系
1.3 术语
术语 描述性定义
Entity： 实体
DAL： 数据访问层
BLL： 业务逻辑层
User Profile： 顾客详细信息
Reeducation： 再教诲
Refer People： 家庭成员
Job History： 职位变更历史记录
Recommendation： 推荐
2 系统构造
2.1软件模块标记：
编 号
模 块 名 称
模 块 标 识
1
人事信息管理
1．1
基本信息管理
User
1．2
详细信息管理
UserProfile
1．3
教诲信息管理
Education
1．4
再教诲信息管理
ReEducation
1．5
工作经验信息管理
Experience
1．6
项目经验信息管理
Project
1．7
技能信息管理
Skill
1．8
家庭成员信息管理
ReferPeople
2
职位变更
2．1
职位空缺登记
Vacancy
2．2
简历信息
同人事信息管理各模块
2．3
面试有关信息
Interview
2．4
领导审批
Interview
2．5
录取状况
JobHistory
2．6
推荐信息
Recommendation
2．7
推荐考核信息
PositionScore
2．8
调职记录信息
JobHistory
3
系统管理
3．1
部门管理
Department
3．2
职位管理
Position
3．3
密码修改
User
表2.1软件模块标记
3 设计阐明
3.1 程序描述
给出对该程序简要描述，重要阐明安排设计本程序目意义，并且，还要阐明本程序特点(如是常驻内存还是非常驻？与否子程序？从属于哪个模块？是可重入还是不可重入？有无覆盖规定？是顺序解决还是并发解决？……等)。
3.2 功能
人力资源管理系统（HRM）分为如下六大模块：人事管理、工资管理、职位变更管理、离职管理、培训管理、辅助系统，各模块基本功能如下：
人事管理模块：涉及人员档案、个人档案和部门机构维护（人员新增、修改、查看功能；个人档案修改、查看功能，以及部门机构新增、删除、修改、查看功能）。
工资管理模块：涉及基本工资设立；考勤、考核资料导入；以及最后工资报表查询和打印。
职位变更管理：涉及职位空缺维护（新增、删除、修改、查看、审核），应聘人员登记、面试安排和考核；员工推荐登记和考核；人事和领导审批；调职记录维护（新增、删除、修改、查看）。
离职管理模块：涉及离职申请、审批以及离职信息维护。
培训管理模块：涉及培训课程、培训讲师档案维护；培训需求维护（收集、审核）；以及培训课程安排、培训考核和培训反馈维护。
辅助系统模块：涉及数据备份、还原；员工权限设立；个人密码修改；以及退出系统功能。
3.3 性能
1.数据精准度
逐项阐明输入、输出及解决数据精度。
公共阐明：依照数据有效性，针对不同信息定义了不同数据输入规定、预期输出成果以及数据精准度。
时间特性：
如响应时间、解决时间、数据传播时间和转换时间等。
响应时间：页面初次访问响应时间为<5s，非初次访问响应时间为<3s；
解决时间：页面解决时间为<3s；
数据传播时间和转换时间：页面数据传播时间和转换时间为<3s；
注：考虑到设备、环境问题（如：计算机性能、网络带宽等），其时间特性有所不同。这里咱们以正常、稳定设备、环境为准。
2.适应性
阐明当操作方式、运营环境发生某些变化时，本软件适应能力。
服务器端：须安装有WEB服务管理软件（例如IIS），DotNet Framework2.0框架组件，否则将无法运营该系统。
客户端：拥有浏览器（例如：IE）并支持页面脚本（例如：JavaScript），即可浏览该系统，反之，则无法浏览该系统。
3.安全保密
阐明该软件在安全保密方面设计考虑和实际达到能力。
页面权限：在安全保密方面，依照不同员工设立了页面访问权限（即正常显示和无权访问两种）。
数据保密：由于涉及到数据敏感问题（例如工资、密码），防止被意外获取，对这些敏感数据进行了加密。
3.4 基本信息管理
（一）、表达层
图3.1 基本信息管理表达层
（二）、业务逻辑层
功能描述：对顾客基本信息进行管理
模块编号：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.5 输出项
给出对每一种输出参数特性，涉及名称、标记、数据类型和格式、数据值域、输出形式、数量和频度、输出媒体、对输出图形及符号阐明、安全保密条件等。
4 运营环境
4.1 硬件环境
最低硬件规定：
WEB服务器
机器类型
硬件配备
台式PC、笔记本电脑
CPU 奔腾IV 1.6G，内存 256M以上，硬盘10G以上，网络适配器（以不同方式接入网络，例如：LAN，WAN，Internet/Intranet）
客户端
机器类型
硬件配备
台式PC、笔记本电脑
普通配备即可，另网络适配器（以不同方式接入网络，例如：LAN，WAN，Internet/Intranet），显示屏800*600
软件环境
4.2 软件环境
最低软件规定：
WEB服务器
操作系统
其她应用软件
Windows Enterprise Server
.Net Framework2.0
客户端
操作系统
其她应用软件
Windows系列操作系统
IE6.0或以上
第4章 实训日记
第1天：自由分组，选取题目。咱们小组5个人选取题目是人力资源管理系统。
第2天：去图书馆查阅了大量关于人力资源管理系统软件工程文档有关资料并在网上查找了某些关于软件工程设计资料，并且布置给每个组内成员相应任务，分派了每个人设计文档阐明书各某些，并且要对每个细节要进行全面设计和阐明。
第3天：整顿从图书馆和网上收集来资料和程序代码，分析模块功能，阅读软件工程书籍，对软件工程文档撰写有了一定理解， 理解对软件工程文档作用及分类并对其中内容整顿到报告中，理解软件工程文档所采用原则及分类并对内容整顿到报告中，整顿软件工程文档重要内容到报告中，完毕报告实例一，对其中遇到问题记录下来，然后通过从网上查资料找答案和人们共同研究摸索解决，再完毕实例一之后用同样方式按部就班进行着实例二编写，再完毕实例二之后，通过2周实训，完毕实训总结内容，总结这2周收获。
第4天：完毕人力资源管理系统软件工程文档报告，上交作品。
第5章 实训总结
人力资源管理系统可以使得管理者迅速高效地完毕公司寻常事务中人事工作，减少了人力资源管理成本，使管理者能集中精力在公司战略目的；另一方面，通过软件及时收集与整顿分析大量人力资源管理数据，为公司战略决策生成与实行控制提供强有力支持，以提高组织目的实现也许性。人力资源管理系统总目的是：在计算机网络，数据库和先进开发平台上，运用既有软件，配备一定硬件，开发一种具备开放体系构造、易扩充、易维护、具备良好人机交互界面人力资源管理系统，实现洛克公司人力资源管理自动化计算机系统，为公司决策层提供精确、精细、迅速人事变动信息。
通过两周实训，使我对软件工程文档知识有了进一步理解，这是一次全面综合训练。咱们通过学习《实用软件工程》这门课程，才可以成功完毕了这次课程设计，在实验过程中虽然遇到了诸多问题，但是通过从图书馆里借来资料和从网上查找资料都把问题一一地解决了。这次课程设计重要是让咱们加深对软件工程文档写作基本知识理解，掌握并运用软件工程文档写作来设计系统程序基本办法及基本技巧。这与咱们平时学知识息息有关，也有助于咱们较好地把学会知识应用到实践中去。
这次课程设计使我得到了充分锻炼，真是受益匪浅。从中也结识到了团队重要性。虽然也遇到过诸多困难，但通过咱们这个小团队努力以及教师协助，都把困难一一克服了。通过这学期学习，使我又掌握了不少新知识，使我对软件工程这门课更加感兴趣，感谢教师及同窗对我协助，我会更加努力学习，来使自己知识更加丰富。
参照文献
[1] 王新颖.《软件工程与文档编写》. 北京大学出版社 ..6
[2] 郑人杰. 《实用软件工程（第4版）》清华大学出版社 ..4
[3] 唐任仲. 《工程应用软件开发技术》.化学工业出版社 .1999.5
[4] 潘孝铭. 《软件文档编写》.高等教诲出版社. .2
[5] 肖刚. 《实用软件文档写作》.清华大学出版社 ..6
[6] 刘冰. 《软件工程实践教程》.机械工业出版社. .1
[7] 徐世河. 《管理信息系统设计教程》. 电子工业出版社. .8
[8] 顾小航. 《软件工程技术原理》.中华人民共和国青年出版社. .5
[9] 赵池龙. 《实用软件工程》.电子工业出版社. .3
[10] 吴东强. 《实用软件工程技术》. 电子工业出版社. .6
[11] 张应辉. 《软件工程技术》. 北京航空航天大学出版社. .1
[12] 吴洁明. 《软件工程基本实践教程》. 清华大学出版社. .11
[13] 候清富. 《软件工程师实战基本功》. 人民邮电出版社. .1
[14] 徐军.《软件工程基本》.重庆大学出版社. .3
[15] 文斌.《软件工程与软件文档写作》.北方交通大学出版社 ..8</p>
展开阅读全文
浙ICP备2021020529号-1 | 浙B2-20240490 
