软件文档写作实训报告- 人力资源管理系统软件文档.doc

实训任务及评语 院（系）：软件学院 教研室：软件教研室 学 号 学生姓名 专业班级 实训题目 人力资源管理系统软件文档 实训任务 实训任务及要求： 了解软件开发周期各阶段的文档。 掌握各文档阐述的内容及作用。 了解文档所采用的国际、国家等相关标准。 了解各文档所涉及的软件知识。 掌握各文档采用的描述工具。 具体编写出2个主要的软件文档。 实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。正确地完成上述内容，记录实习日记，规范完整地撰写出实训报告。 几个人为一组完成一个相对完整的软件系统开发文档，组内成员编写的文档不能重复，文档要严格按照所采用的标准编写，图表布局要合理规范。 指导教师评语及成绩 成绩： 指导教师签字： 年 月 日 目 录 第1章 实训目的与要求 1 1.1 实训目的 1 1.2 实训的实验环境 1 1.3 实训的预备知识 1 1.4 实训要求 1 第2章 软件文档及其组成 2 2.1软件文档的作用及分类 2 2.2软件文档所采用的标准 4 2.3 软件文档的主要内容 5 第3章 实 例 6 3.1 人力资源管理系统详细设计说明书实例 6 3.2 人力资源管理系统用户手册实例 10 第4章 实训日记 14 第5章 实训总结 15 参考文献 16 第1章 实训目的与要求 1.1 实训目的 本实训要求学生通过具体的实例，模仿软件开发过程中软件文档写作的具体方法和步骤，分组完成一套较为简单软件文档，具体要达到以下几点目的。 1、了解软件开发周期各阶段的文档。 2、掌握各文档阐述的内容及作用。 3、了解文档所采用的国际、国家等相关标准。 4、了解各文档所涉及的软件知识。 5、掌握各文档采用的描述工具。 6、具体编写出2个主要的软件文件。 1.2 实训的实验环境 学校图书馆，互联网查询环境，具有软件图表制作软件的计算机。 1.3 实训的预备知识 要求学生修完全部专科所有课程，具有较全面计算机软件知识和一定的文献检索能力及动手实践能力。该实训应安排在毕业设计之前进行。 1.4 实训要求 实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。正确地完成上述内容，记录实习日记，规范完整地撰写出实训报告。 软件文档及其组成 2.1软件文档的作用及分类 软件文档可以分为开发文档和产品文档两大类。 开发文档包括：《功能要求》、《投标方案》、《需求分析》、《技术分析》、《系统分析》、《数据库文档》、《功能函数文档》、《界面文档》、《编译手册》、《QA文档》、《项目总结》等。 产品文档包括：《产品简介》、《产品演示》、《疑问解答》、《功能介绍》、 《技术白皮书》、《评测报告》、《安装手册》、《使用手册》、《维护手册》、 《用户报告》、《销售培训》等。 一、开发文档： 1. 《功能要求》--来源于客户要求和市场调查，是软件开发中最早期的一个环节。客户提出一个模糊的功能概念，或者要求解决一个实际问题，或者参照同类软件的一个功能。有软件经验的客户还会提供比较详细的技术规范书，把他们的要求全部列表书写在文档中，必要时加以图表解说。这份文档是需求分析的基础。 2. 《投标方案》--根据用户的功能要求，经过与招标方沟通和确认。 3. 《需求分析》--包括产品概述、主要概念、操作流程、功能列表和解说、注意事项、系统环境等。 4. 《技术分析》--包括技术选型、技术比较、开发人员、关键技术问题的解决、技术风险、技术升级方向、技术方案评价，竞争对手技术分析等。以《需求分析》为基础，进行详细的技术分析，列出本项目需要使用什么技术方案，有哪些技术问题要解决 ，估计开发期间会碰到什么困难，技术方案以后如何升级，对本项目的技术有什么评价等。 5. 《系统分析》--包括功能实现、模块组成、功能流程图、函数接口、数据字典、软件开发需要考虑的各种问题等。以《需求分析》为基础，进行详细的系统分析(产品的开发和实现方法)，估计开发期间需要把什么问题说明白，程序员根据《系统分析》，开始在项目主管的带领下进行编码。 6. 《数据库文档》--包括数据库名称、表名、字段名、字段类型、字段说明、备注、字段数值计算公式等。以《系统分析》为基础，进行详细的数据库设计。必要时可以用图表解说，特别是关系数据库。 7. 《功能函数文档》--包括变量名、变量初植、功能，函数名，参数，如何调用、备注、注意事项等。以《系统分析》为基础，进行详细的说明，列出哪个功能