人力资源管理系统软件文档091401058杨丽娟

1、1 / 18辽宁工业大学软件文档写作实训报告题目人力资源管理系统软件文档院（系）：软件学院专业班级：电子商务 092092 班学 号： 091401058091401058_学生姓名：杨丽娟_指导教师：张莉莉_教师职称：助教_起止时间：2011.11.28-2011.12.032 / 183 / 18实训任务及评语4 / 18目录号学口冃女杨目1训头实训任务编合O O、-c c了,佈小MM WMS,?,WMS,?,指写文叭从撰发瑚听地开恥，整统WWO O排完系小皿安范件呦咖间规软一际。关时，的前/相3030的记整册加。弯。训日完对、収用傢识。和实习对锦段划、伸XMXM侦炽；！们要txtx主:记

2、要内J J : :MwowMwow采2 2叽邵V重0 0钿各対各各晞训完个档。齡解握解解挠MM实地几文范WW了掌了了掌具确的规O O、正写理箋1 1 2 2 3 3 4 4 5 5 6 6指导教师评语及成绩日0303月2 2:年指2020成院（系）：软件学院教研室：软件教研室第1章 实训目的与要求. . 11.1实训目的. . 11.2实训的实验环境. . 11.3实训的预备知识. . 11.4实训要求. . 1第2章 软件文档及其组成. . 22.1软件文档的作用及分类. . 22.2软件文档所采用的标准. . 42.2软件文档的主要内容. . 4第3章 实 例. . 63.1人力资源管理系

3、统详细设计说明书实例. . 6第4章 实训日记. . 13第5章 实训总结. . 14参考文献. . 151 / 18第1章 实训目的与要求1.11.1 实训目的本实训要求学生通过具体的实例，模仿软件开发过程中软件文档写作的具体方法和 步骤，分组完成一套较为简单软件文档，具体要达到以下几点目的。1、了解软件开发周期各阶段的文档。2、掌握各文档阐述的内容及作用。3、了解文档所采用的国际、国家等相关标准。4、了解各文档所涉及的软件知识。5、掌握各文档采用的描述工具。6、具体编写出2个主要的软件文件。1.21.2 实训的实验环境学校图书馆，互联网查询环境，具有软件图表制作软件的计算机。1.31.3

4、实训的预备知识要求学生修完全部专科所有课程，具有较全面计算机软件知识和一定的文献检索能力及动手实践能力。该实训应安排在毕业设计之前进行。1.41.4 实训要求实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。正确地完成上述内容，记录实习日记，规范完整地撰写出实训报告。第2章 软件文档及其组成2.12.1 软件文档的作用及分类软件文档可以分为开发文档和产品文档两大类。 开发文档包括：功能要求、投标方案、需求分析、技术分析、系统分 析、数据库文档、功能函数文档、界面文档、编译手2 / 18册、QA文档项目 总结等。产品文档包括：产品简介、产品演示、疑问解答、功能介绍、技术白皮 书、评测报告

5、、安装手册、使用手册、维护手册、用户报告、销售培训 等。一、开发文档：1.功能要求-来源于客户要求和市场调查，是软件开发中最早期的一个环节。 客户提出一个模糊的功能概念，或者要求解决一个实际问题，或者参照同类软件的一个 功能。有软件经验的客户还会提供比较详细的技术规范书，把他们的要求全部列表书写 在文档中，必要时加以图表解说。这份文档是需求分析的基础。2.投标方案-根据用户的功能要求，经过与招标方沟通和确认。3.需求分析-包括产品概述、主要概念、操作流程、功能列表和解说、注意事 项、系统环境等。4.技术分析-包括技术选型、技术比较、开发人员、关键技术问题的解决、技 术风险、技术升级方向、技术方

6、案评价，竞争对手技术分析等。以需求分析为基础， 进行详细的技术分析， 列出本项目需要使用什么技术方案， 有哪些技术问题要解决 ，估 计开发期间会碰到什么困难，技术方案以后如何升级，对本项目的技术有什么评价等。5.系统分析-包括功能实现、模块组成、功能流程图、函数接口、数据字典、 软件开发需要考虑的各种问题等。 以需求分析 为基础，进行详细的系统分析（产品的 开发和实现方法），估计开发期间需要把什么问题说明白，程序员根据系统分析 ，开 始在项目主管的带领下进行编码。6.数据库文档-包括数据库名称、表名、字段名、字段类型、字段说明、备注、 字段数值计算公式等。以系统分析为基础，进行详细的数据库设计

7、。必要时可以用 图表解说，特别是关系数据库。7.功能函数文档-包括变量名、变量初植、功能，函数名，参数，如何调用、 备注、注意事项等。以系统分析为基础，进行详细的说明，列出哪个功能涉及多少 个函数，以便以后程序员修改、接手和扩展。8.界面文档-包括软件外观、界面素材、编辑工具、文件名、菜单、按钮和其 它界面部件的要求，这里与软件完成后的运行界面是一致的。9.编译手册-包括服务器编译环境、操作系统、编译工具、GNU勺C+编译器 版本信息、目录说明、程序生成、源程序文件列表、Makefile配置及其相关程序的对应 关系列表。10.QA文档-包括产品简介、产品原理、产品功能列表、功能描述、功能流程、

8、 执行结果、数据库结构、测试要求等，提供给软件测试人员使用。11.项目总结-包括项目简介、项目参与人员和开发时间、项目风险管理过程、 项目功能列表、项目结构特点、技术特点、对项目勺升级建议、对以后勺项目勺建议、 人员素质情况等。二、产品文档：1.产品简介-包括公司背景、产品概念、适用范围、产品功能、功能特点、运 行要求和公司联系地址。3 / 182.产品演示-包括公司简介、产品背景、产品描述、产品特点、产品作用、适 用范围、 使用分析、 功能模块、 解决问题、 合作伙伴、 成功案例等。 一般用Power、point或者VCD录制软件实现。3.疑问解答-列出用户关心勺问题和处理方法。用于解答软件勺操作功能和解 决用户勺疑难问题。4.功能介绍-以需求分析为书写基础，包括软件介绍、软件结构、功能列 表、功能描述和公司联系地址。5.技术白皮书-以技术分析为书写基础，包括功能实现、技术选型、关键 技术问题勺解决、技术方案特点、技术升级方向等。6.评测报告-第三方权威评测报告。包括评测目勺、评测范围、评测环境、评 测内容、实测数据、性能表现、结果分析和评测总结等。7.安装手册-包括系统环境、运行平台、产品安装过程、初始环境设置、安装 记录等。8.使用手册-包括产品简介、功能列表、功能描述和解释、功能操作、客户服 务和联系方式等。9.维护手册-包括产品简介、系统须知、初始环境