《软件文档写作实训报告-人力资源管理系统》由会员分享，可在线阅读，更多相关《软件文档写作实训报告-人力资源管理系统（19页珍藏版）》请在金锄头文库上搜索。
1、辽 宁 工 业 大 学软件文档写作 实训报告题目： 人力资源管理系统 院（系）: 软件学院 专业班级： 软件工程 102 班 学 号： 学生姓名： 指导教师： 教师职称： 副教授 起止时间： 2011.12.5-2011.12.11 实训任务及评语院（系）：软件学院 教研室：软件教研室学 号 学生姓名 专业班级 软件工程 102实训题目 人力资源管理系统实训任务实训任务及要求：1、了解软件开发周期各阶段的文档。2、掌握各文档阐述的内容及作用。3、了解文档所采用的国际、国家等相关标准。4、了解各文档所涉及的软件知识。5、掌握各文档采用的描述工具。6、具体编写出 2 个主要的软件文档。实训过程中，
2、要严格遵守实训的时间安排，听从指导教师的指导。正确地完成上述内容，记录实习日记，规范完整地撰写出实训报告。几个人为一组完成一个相对完整的软件系统开发文档，组内成员编写的文档不能重复，文档要严格按照所采用的标准编写，图表布局要合理规范。指导教师评语及成绩成绩： 指导教师签字： 年 月 日辽 宁 工 业 大 学 课 程 设 计 说 明 书（论 文）目 录第 1 章 实训目的与要求 .11.1 实训目的 .11.2 实训的实验环境 .11.3 实训的预备知识 .11.4 实训要求 .1第 2 章 软件文档及其组成 .22.1 软件文档的作用及分类 .22.2 软件文档所采用的标准 .42.3 软件文
3、档的主要内容 .4第 3 章 实 例 .63.1 人力资源管理系统详细设计说明书实例 .63.2 人力资源管理系统用户手册实例 .11第 4 章 实训日记 .15第 5 章 实训总结 .16参考文献 .17辽 宁 工 业 大 学 综 合 实 训 说 明 书（论 文）1第 1 章 实训目的与要求1.1 实训目的 本实训要求学生通过具体的实例，模仿软件开发过程中软件文档写作的具体方法和步骤，分组完成一套较为简单软件文档，具体要达到以下几点目的。1、了解软件开发周期各阶段的文档。2、掌握各文档阐述的内容及作用。3、了解文档所采用的国际、国家等相关标准。4、了解各文档所涉及的软件知识。5、掌握各文档采
4、用的描述工具。6、具体编写出 2 个主要的软件文件。 1.2 实训的实验环境学校图书馆，互联网查询环境，具有软件图表制作软件的计算机。1.3 实训的预备知识要求学生修完全部专科所有课程，具有较全面计算机软件知识和一定的文献检索能力及动手实践能力。该实训应安排在毕业设计之前进行。1.4 实训要求实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。正确地完成上述内容，记录实习日记，规范完整地撰写出实训报告。辽 宁 工 业 大 学 综 合 实 训 说 明 书（论 文）2第 2 章 软件文档及其组成2.1 软件文档的作用及分类文档是计算机软件产品的重要组成部分，没有文档就不成其为软件，也更不能成
5、为软件产品。软件文档是一种重要的软件工程技术资料。如系统分析文档、设计文档、版本说明文档软件文档的规范编制，在软件开发工作中占有突出的地位和相当大的工作量。高质量、高效率的编制、分发、管理、维护文档，及时的变更、修正、扩充和使用文档，对于软件产品的设计开发、发行使用、变更维护、转让移植、二次开发等，对于充分发挥软件产品的效益，都有着重要的意义。基于软件生存期方法，可以从形式上将软件文档大致分成两类：软件开发过程中需要填写的各种图表，及应编制的各种技术文件或管理资料。软件文档根据其产生和使用的范围，主要划分为 3 大类：开发文档、用户文档和管理文档。一、开发文档： 1.1 功能要求-来源于客户要
6、求和市场调查，是软件开发中最早期的一个环节。客户提出一个模糊的功能概念，或者要求解决一个实际问题，或者参照同类软件的一个功能。有软件经验的客户还会提供比较详细的技术规范书，把他们的要求全部列表书写在文档中，必要时加以图表解说。这份文档是需求分析的基础。1.2 投标方案-根据用户的功能要求，经过与招标方沟通和确认。1.3.需求分析-包括产品概述、主要概念、操作流程、功能列表和解说、注意事项、系统环境等。1.4 技术分析-包括技术选型、技术比较、开发人员、关键技术问题的解决、技术风险、技术升级方向、技术方案评价，竞争对手技术分析等。以需求分析为基础，进行详细的技术分析，列出本项目需要使用什么技术方
7、案，有哪些技术问题要解决 ，估计开发期间会碰到什么困难，技术方案以后如何升级，对本项目的技术有什么评价等。1.5.系统分析-包括功能实现、模块组成、功能流程图、函数接口、数据字典、软件开发需要考虑的各种问题等。以需求分析为基础，进行详细的系统分析(产品的开发和实现方法)，估计开发期间需要把什么问题说明白，程序员根据系统分析 ，开始在项目主管的带领下进行编码。 1.6.数据库文档-包括数据库名称、表名、字段名、字段类型、字段说明、备注、字段数值计算公式等。以系统分析为基础，进行详细的数据库设计。必要时可以用图表解说，特别是关系数据库。辽 宁 工 业 大 学 综 合 实 训 说 明 书（论 文）3
8、1.7.功能函数文档-包括变量名、变量初植、功能，函数名，参数，如何调用、备注、注意事项等。以系统分析为基础，进行详细的说明，列出哪个功能涉及多少个函数，以便以后程序员修改、接手和扩展。1.8.界面文档-包括软件外观、界面素材、编辑工具、文件名、菜单、按钮和其它界面部件的要求，这里与软件完成后的运行界面是一致的。 1.9 编译手册-包括服务器编译环境、操作系统、编译工具、GNU 的 C+编译器版本信息、目录说明、程序生成、源程序文件列表、Makefile 配置及其相关程序的对应关系列表。1.10 QA 文档-包括产品简介、产品原理、产品功能列表、功能描述、功能流程、执行结果、数据库结构、测试要
9、求等，提供给软件测试人员使用。 1.11 项目总结-包括项目简介、项目参与人员和开发时间、项目风险管理过程、项目功能列表、项目结构特点、技术特点、对项目的升级建议、对以后的项目的建议、人员素质情况等。二、用户文档：2.1 产品简介-包括公司背景、产品概念、适用范围、产品功能、功能特点、运行要求和公司联系地址。2.2 产品演示-包括公司简介、产品背景、产品描述、产品特点、产品作用、适用范围、使用分析、功能模块、解决问题、合作伙伴、成功案例等。一般用Power、point 或者 VCD 录制软件实现。2.3 疑问解答-列出用户关心的问题和处理方法。用于解答软件的操作功能和解决用户的疑难问题。 2.
10、4 功能介绍-以需求分析为书写基础，包括软件介绍、软件结构、功能列表、功能描述和公司联系地址。2.5 技术白皮书-以技术分析为书写基础，包括功能实现、技术选型、关键技术问题的解决、技术方案特点、技术升级方向等。2.6 评测报告-第三方权威评测报告。包括评测目的、评测范围、评测环境、评测内容、实测数据、性能表现、结果分析和评测总结等。三、管理文档：3.1 安装手册-包括系统环境、运行平台、产品安装过程、初始环境设置、安装记录等。3.2 使用手册-包括产品简介、功能列表、功能描述和解释、功能操作、客户服务和联系方式等。3.3 维护手册-包括产品简介、系统须知、初始环境设置、系统配置、数据管理和备份
11、、技术问题解答和联系方式等。3.4 用户报告-包括产品简介、购买时间、使用目的、使用时间、使用地点、辽 宁 工 业 大 学 综 合 实 训 说 明 书（论 文）4实施过程、出现问题和解决、产品总结和建议等。3.5销售培训-包括项目简介、产品功能、产品特点、商业优势、系统运行环境、适用范围、目标客户等。2.2 软件文档所采用的标准参照其它工程领域对工程标准划分的方法，软件工程标准主要有两种划分方法：按标准的类型划分和按标准的范围划分。2.2.1 按标准的类型划分：按标准的类型划分主要有过程标准、产品标准、行业标准、记法标准等。过程标准与开发一个产品或从事一项服务的一系列活动或操作有关。过程标准使
12、用一组方法、工具和技术，给出“谁来做” 、 “做什么” 、 “如何做” 、 “何时做” 、 “何地做”及在软件工程活动中进行的不同层次工作的过程模型。产品标准则涉及软件工程事务的格式和内容。软件开发和维护活动文档化的结果就是软件产品，软件文档是软件工程活动进一步开展的基础。软件开发作为一种行业，其行业标准涉及软件工程的所有方面，如职业认证、职业培训、产品许可等。行业标准可以等同于行业行为规范。记法标准规定了在软件工程行业范围内，以唯一的方式进行交流的方法，如术语、表示法、语言等。它其实是一种语境规范。2.2.2 按标准的范围划分：按标准的范围划分主要是根据软件的任务功能和软件生存期进行比较、判
13、定、评价和确定软件工程标准的范围和内容。任务功能可以表示软件工程过程，可以划分为产品工程功能、验证与确认功能以及技术管理功能 3 个部分。产品工程功能包括定义、生产和支持最终产品所必须的过程。验证和确认功能是检查产品质量的活动。技术管理功能是构造和控制产品工程的过程。这 3 个部分并不集中在单个的软件生存周期里，而是并行进行的生产、检查和控制活动。2.3 软件文档的主要内容我所做的软件文档是人力资源管理系统软件文档。人力资源管理系统软件文档包括人力资源管理系统操作手册、人力资源管理系统测试计划、人力资源管理系统概要设计说明书、人力资源管理系统可行性分析报告、人力资源系统管理系统需求说明书、人力资源管理系统详细设计说明书、人力
