软件文档写作实训报告(耀坤)人力资源管理.doc

1、辽 宁 工 业 大 学 软件文档写作 实训报告题目： 人力资源管理系统软件文档 院（系）: 软件学院 专业班级： 软件技术081班 学 号： 081404009 学生姓名： 安凯辰 指导教师： 王彦华 教师职称： 助教 起止时间： 2010.11.22-2010.12.6 实训任务及评语院（系）：软件学院 教研室：软件教研室学 号081404009学生姓名安凯辰专业班级软件技术081班实训题目 人力资源管理系统软件文档实训任务实训任务及要求：1、 了解软件开发周期各阶段的文档。2、 掌握各文档阐述的内容及作用。3、 了解文档所采用的国际、国家等相关标准。4、 了解各文档所涉及的软件知识。5、

2、掌握各文档采用的描述工具。6、 具体编写出2个主要的软件文档。实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。正确地完成上述内容，记录实习日记，规范完整地撰写出实训报告。几个人为一组完成一个相对完整的软件系统开发文档，组内成员编写的文档不能重复，文档要严格按照所采用的标准编写，图表布局要合理规范。指导教师评语及成绩成绩： 指导教师签字： 年 月 日辽 宁 工 业 大 学 综 合 实 训 说 明 书（论 文）目 录第1章 实训目的与要求11.1 实训目的11.2 实训的实验环境11.3 实训的预备知识11.4 实训要求1第2章 软件文档及其组成22.1软件文档的作用及分类22.2软件文

3、档所采用的标准52.2 软件文档的主要内容5第3章 实 例73.1 人力资源管理系统数据库设计实例73.2人力资源管理系统操作手册实例13第4章 实训日记21第5章 实训总结22参考文献23第1章 实训目的与要求1.1 实训目的 本实训要求学生通过具体的实例，模仿软件开发过程中软件文档写作的具体方法和步骤，分组完成一套较为简单软件文档，具体要达到以下几点目的。1、了解软件开发周期各阶段的文档。2、掌握各文档阐述的内容及作用。3、了解文档所采用的国际、国家等相关标准。4、了解各文档所涉及的软件知识。5、掌握各文档采用的描述工具。6、具体编写出2个主要的软件文件。 1.2 实训的实验环境学校图书馆

4、，互联网查询环境，具有软件图表制作软件的计算机。1.3 实训的预备知识 要求学生修完全部专科所有课程，具有较全面计算机软件知识和一定的文献检索能力及动手实践能力。该实训应安排在毕业设计之前进行。1.4 实训要求实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。正确地完成上述内容，记录实习日记，规范完整地撰写出实训报告。 第2章 软件文档及其组成2.1软件文档的作用及分类1. 软件文档的作用： 提高软件开发过程的能见度。把开发过程中发生的事件以某种可阅读的形式记录在文档中。管理人员可把这些记载下来的材料作为检查软件开发进度和开发质量的依据，实现对软件开发的工程管理。 提高开发效率。软件文

5、档的编制，使得开发人员对各个阶段的工作都进行周密思考、全盘权衡、从而减少返工。并且可在开发早期发现错误和不一致性，便于及时加以纠正。 作为开发人员在一定阶段的工作成果和结束标志。 记录开发过程中的有关信息，便于协调以后的软件、开发、使用和维护。 提供对软件的运行、维护和培训的有关信息，便于管理人员、开发人员、操作人员、用户之间的协作、交流和了解。使软件开发活动更科学、更有成效。 便于潜在用户了解软件的功能、性能等各项指标，为他们选购符合自己需要的软件提供依据。文档在各类人员、计算机之间的多种桥梁作用中看出：既然软件已经从手工艺人的开发方式发展到工业化的生产方式，文档在开发过程中就起到关键作用，

6、从某种意义上来说，文档是软件开发。规范的体现和指南。按规范要求生成一整套文档的过程，就是按照软件开发规范完成一个软件开发的过程。所以，在使用工程化的原理和方法来指导软件的开发和维护时，应当充分注意软件文档的编制和管理。2. 软件文档的分类：软件文档可以分为开发文档和产品文档两大类，如下图：软件文档开发文档产品文档功能要求需求分析技术分析系统分析数据库文档功能函数文档界面文档产品简介产品演示功能介绍技术白皮书使用手册用户手册维护手册图2-1软件文档分类图（1）、开发文档： 功能要求-来源于客户要求和市场调查，是软件开发中最早期的一个环节。客户提出一个模糊的功能概念，或者要求解决一个实际问题，或者

7、参照同类软件的一个功能。有软件经验的客户还会提供比较详细的技术规范书，把他们的要求全部列表书写在文档中，必要时加以图表解说。这份文档是需求分析的基础。 需求分析-包括产品概述、主要概念、操作流程、功能列表和解说、注意事项、系统环境等。 技术分析-包括技术选型、开发人员、关键技术问题的解决、技术风险、技术升级方向等。以需求分析为基础，进行详细的技术分析，列出本项目需要使用什么技术方案，有哪些技术问题要解决 ，估计开发期间会碰到什么困难，技术方案以后如何升级，对本项目的技术有什么评价等。 系统分析-包括功能实现、模块组成、功能流程图、函数接口、数据字典、软件开发需要考虑的各种问题等。以需求分析为基

8、础，进行详细的系统分析(产品的开发和实现方法)，程序员根据系统分析，开始在项目主管的带领下进行编码。 数据库文档-包括数据库名称、表名、字段名、字段类型、字段说明、备注、字段数值计算公式等。以系统分析为基础，进行详细的数据库设计。必要时可以用图表解说，特别是关系数据库。 功能函数文档-包括变量名、变量初植、功能，函数名，参数，如何调用、备注、注意事项等。以系统分析为基础，进行详细的说明，列出哪个功能涉及多少个函数，以便以后程序员修改、接手和扩展。 界面文档-包括软件外观、界面素材、编辑工具、文件名、菜单、按钮和其它界面部件的要求，这里与软件完成后的运行界面是一致的。 编译手册-包括服务器编译环

9、境、操作系统、编译工具、GNU的C+编译器版本信息、目录说明、程序生成、源程序文件列表、Makefile配置及其相关程序的对应关系列表。 项目总结-包括项目简介、项目参与人员和开发时间、项目风险管理过程、项目功能列表、项目结构特点、技术特点、对项目的升级建议、对以后的项目的建议、人员素质情况等。（2）、产品文档： 产品简介-包括公司背景、产品概念、适用范围、产品功能、功能特点、运行要求和公司联系地址。 疑问解答-列出用户关心的问题和处理方法。用于解答软件的操作功能和解决用户的疑难问题。 功能介绍-以需求分析为书写基础，包括软件介绍、软件结构、功能列表、功能描述和公司联系地址。 技术白皮书-以技

10、术分析为书写基础，包括功能实现、技术选型、关键技术问题的解决、技术方案特点、技术升级方向等。 评测报告-第三方权威评测报告。包括评测目的、评测范围、评测环境、评测内容、实测数据、性能表现、结果分析和评测总结等。 安装手册-包括系统环境、运行平台、产品安装过程、初始环境设置、安装记录等。 使用手册-包括产品简介、功能列表、功能描述和解释、功能操作、客户服务和联系方式等。 维护手册-包括产品简介、系统须知、初始环境设置、系统配置、数据管理和备份、技术问题解答和联系方式等。 用户报告-包括产品简介、购买时间、使用目的、使用时间、使用地点、实施过程、出现问题和解决、产品总结和建议等。2.2软件文档所采

11、用的标准参照其它工程领域对工程标准划分的方法，软件工程标准主要有两种划分方法：按标准的类型划分和按标准的范围划分。一、按标准的类型划分：按标准的类型划分主要有过程标准、产品标准、行业标准、记法标准等。过程标准与开发一个产品或从事一项服务的一系列活动或操作有关。过程标准使用一组方法、工具和技术，给出“谁来做”、“做什么”、“如何做”、“何时做”、“何地做”及在软件工程活动中进行的不同层次工作的过程模型。产品标准则涉及软件工程事务的格式和内容。软件开发和维护活动文档化的结果就是软件产品，软件文档是软件工程活动进一步开展的基础。软件开发作为一种行业，其行业标准涉及软件工程的所有方面，如职业认证、职业

12、培训、产品许可等。行业标准可以等同于行业行为规范。记法标准规定了在软件工程行业范围内，以唯一的方式进行交流的方法，如术语、表示法、语言等。它其实是一种语境规范。二、按标准的范围划分：按标准的范围划分主要是根据软件的任务功能和软件生存期进行比较、判定、评价和确定软件工程标准的范围和内容。任务功能可以表示软件工程过程，可以划分为产品工程功能、验证与确认功能以及技术管理功能3个部分。产品工程功能包括定义、生产和支持最终产品所必须的过程。验证和确认功能是检查产品质量的活动。技术管理功能是构造和控制产品工程的过程。这3个部分并不集中在单个的软件生存周期里，而是并行进行的生产、检查和控制活动。2.2 软件

13、文档的主要内容此次所做的软件文档是人力资源管理系统软件文档。在此次人力资源管理系统软件文档编写包括人力资源管理系统操作手册、人力资源管理系统数据库设计说明书、人力资源管理系统概要设计说明书、人力资源管理系统用户手册、人力资源系统管理系统需求说明书、人力资源管理系统详细设计说明书、人力资源管理系统开发计划说明书、人力资源管理系统测试分析说明书等。人力资源管理系统（HRM）分为以下六大模块：人事管理、工资管理、职位变更管理、离职管理、培训管理、辅助系统，各模块的基本功能如下：1) 人事管理模块：包括人员档案、个人档案和部门机构的维护（人员的新增、修改、查看功能；个人档案的修改、查看功能，以及部门机

14、构的新增、删除、修改、查看功能）。2) 工资管理模块：包括基本工资的设置；考勤、考核资料的导入；以及最终工资报表的查询和打印。3) 职位变更管理：包括职位空缺的维护（新增、删除、修改、查看、审核），应聘人员的登记、面试安排和考评；员工推荐的登记和考评；人事和领导的审批；调职记录的维护（新增、删除、修改、查看）。4) 离职管理模块：包括离职的申请、审批以及离职信息的维护。5) 培训管理模块：包括培训课程、培训讲师档案的维护；培训需求的维护（收集、审核）；以及培训课程的安排、培训考核和培训反馈的维护。6) 辅助系统模块：包括数据的备份、还原；员工的权限设置；个人密码修改；以及退出系统功能。第3章 实 例3.1 人力资源管理系统数据库设计实例3.1.1引言