软件文档写作实训报告苏博人力资源管理Word下载.docx

资源描述

软件文档写作实训报告苏博人力资源管理Word下载.docx

《软件文档写作实训报告苏博人力资源管理Word下载.docx》由会员分享，可在线阅读，更多相关《软件文档写作实训报告苏博人力资源管理Word下载.docx（23页珍藏版）》请在冰点文库上搜索。

软件文档写作实训报告苏博人力资源管理Word下载.docx

1.1实训目的1

1.2实训的实验环境1

1.3实训的预备知识1

1.4实训要求1

第2章软件文档及其组成2

2.1软件文档的作用及分类2

2.2软件文档所采用的标准3

2.2软件文档的主要内容4

第3章实例5

3.1详细设计实例5

3.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：

业务逻辑层

UserProfile:

用户的详细信息

Reeducation:

再教育

ReferPeople:

家庭成员

JobHistory:

职位变更的历史记录

Recommendation: