软件文档写作实训.docx

软件文档写作实训.docx

《软件文档写作实训.docx》由会员分享，可在线阅读，更多相关《软件文档写作实训.docx（17页珍藏版）》请在冰豆网上搜索。

软件文档写作实训

辽宁工业大学

软件文档写作实训报告

题目：

兼职中介管理系统软件文档

院（系）:

软件学院

教师职称：

副教授

起止时间：

2012.11.26-2012.12.2

实训任务及评语

院（系）、教研室：

软件教研室

学号

实训题目

兼职中介管理系统软件文档

实训任务

实训任务及要求：

1、了解软件开发周期各阶段的文档。

2、掌握各文档阐述的内容及作用。

3、了解文档所采用的国际、国家等相关标准。

4、了解各文档所涉及的软件知识。

5、掌握各文档采用的描述工具。

6、具体编写出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软件文档的主要内容4

第3章实例6

3.1兼职中介管理系统数据要求说明书实例6

3.2兼职中介管理系统项目开发总结报告9

第4章实训日记12

第5章实训总结13

参考文献14

第1章实训目的与要求

1.1实训目的

本实训要求学生通过具体的实例，模仿软件开发过程中软件文档写作的具体方法和步骤，分组完成一套较为简单软件文档，具体要达到以下几点目的。

1、了解软件开发周期各阶段的文档。

2、掌握各文档阐述的内容及作用。

3、了解文档所采用的国际、国家等相关标准。

4、了解各文档所涉及的软件知识。

5、掌握各文档采用的描述工具。

6、具体编写出2个主要的软件文件。

1.2实训的实验环境

学校图书馆，互联网查询环境，具有软件图表制作软件的计算机。

1.3实训的预备知识

要求学生修完全部专科所有课程，具有较全面计算机软件知识和一定的文献检索能力及动手实践能力。

该实训应安排在毕业设计之前进行。

1.4实训要求

实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。

正确地完成上述内容，记录实习日记，规范完整地撰写出实训报告。

第2章软件文档及其组成

2.1软件文档的作用及分类

软件文档可以分为开发文档和产品文档两大类。

开发文档包括：

《功能要求》、《投标方案》、《需求分析》、《技术分析》、《系统分析》、《数据库文档》、《功能函数文档》、《界面文档》、《编译手册》、《QA文档》、《项目总结》等。

产品文档包括：

《产品简介》、《产品演示》、《疑问解答》、《功能介绍》、《技术白皮书》、《评测报告》、《安装手册》、《使用手册》、《维护手册》、《用户报告》、《销售培训》等。

一、开发文档：

1.《功能要求》--来源于客户要求和市场调查，是软件开发中最早期的一个环节。

客户提出一个模糊的功能概念，或者要求解决一个实际问题，或者参照同类软件的一个功能。

有软件经验的客户还会提供比较详细的技术规范书，把他们的要求全部列表书写在文档中，必要时加以图表解说。

这份文档是需求分析的基础。

2.《投标方案》--根据用户的功能要求，经过与招标方沟通和确认。

3.《需求分析》--包括产品概述、主要概念、操作流程、功能列表和解说、注意事项、系统环境等。

4.《技术分析》--包括技术选型、技术比较、开发人员、关键技术问题的解决、技术风险、技术升级方向、技术方案评价，竞争对手技术分析等。

以《需求分析》为基础，进行详细的技术分析，列出本项目需要使用什么技术方案，有哪些技术问题要解决，估计开发期间会碰到什么困难，技术方案以后如何升级，对本项目的技术有什么评价等。

5.《系统分析》--包括功能实现、模块组成、功能流程图、函数接口、数据字典、软件开发需要考虑的各种问题等。

以《需求分析》为基础，进行详细的系统分析（产品的开发和实现方法），估计开发期间需要把什么问题说明白，程序员根据《系统分析》，开始在项目主管的带领下进行编码。

6.《数据库文档》--包括数据库名称、表名、字段名、字段类型、字段说明、备注、字段数值计算公式等。

以《系统分析》为基础，进行详细的数据库设计。

必要时可以用图表解说，特别是关系数据库。

7.《功能函数文档》--包括变量名、变量初植、功能，函数名，参数，如何调用、备注、注意事项等。

以《系统分析》为基础，进行详细的说明，列出哪个功能涉及多少个函数，以便以后程序员修改、接手和扩展。

8.《界面文档》--包括软件外观、界面素材、编辑工具、文件名、菜单、按钮和其它界面部件的要求，这里与软件完成后的运行界面是一致的。

9.《编译手册》--包括服务器编译环境、操作系统、编译工具、GNU的C++编译器版本信息、目录说明、程序生成、源程序文件列表、Makefile配置及其相关程序的对应关系列表。

10.《QA文档》--包括产品简介、产品原理、产品功能列表、功能描述、功能流程、执行结果、数据库结构、测试要求等，提供给软件测试人员使用。

11.《项目总结》--包括项目简介、项目参与人员和开发时间、项目风险管理过程、项目功能列表、项目结构特点、技术特点、对项目的升级建议、对以后的项目的建议、人员素质情况等。

二、产品文档：

1.《产品简介》--包括公司背景、产品概念、适用范围、产品功能、功能特点、运行要求和公司联系地址。

2.《产品演示》--包括公司简介、产品背景、产品描述、产品特点、产品作用、适用范围、使用分析、功能模块、解决问题、合作伙伴、成功案例等。

一般用Power、point或者VCD录制软件实现。

3.《疑问解答》--列出用户关心的问题和处理方法。

用于解答软件的操作功能和解决用户的疑难问题。

4.《功能介绍》--以《需求分析》为书写基础，包括软件介绍、软件结构、功能列表、功能描述和公司联系地址。

5.《技术白皮书》--以《技术分析》为书写基础，包括功能实现、技术选型、关键技术问题的解决、技术方案特点、技术升级方向等。

6.《评测报告》--第三方权威评测报告。

包括评测目的、评测范围、评测环境、评测内容、实测数据、性能表现、结果分析和评测总结等。

7.《安装手册》--包括系统环境、运行平台、产品安装过程、初始环境设置、安装记录等。

8.《使用手册》--包括产品简介、功能列表、功能描述和解释、功能操作、客户服务和联系方式等。

9.《维护手册》--包括产品简介、系统须知、初始环境设置、系统配置、数据管理和备份、技术问题解答和联系方式等。

10.《用户报告》--包括产品简介、购买时间、使用目的、使用时间、使用地点、实施过程、出现问题和解决、产品总结和建议等。

11.《销售培训》--包括项目简介、产品功能、产品特点、商业优势、系统运行环境、适用范围、目标客户等。

2.2软件文档所采用的标准

参照其它工程领域对工程标准划分的方法，软件工程标准主要有两种划分方法：

按标准的类型划分和按标准的范围划分。

一、按标准的类型划分：

按标准的类型划分主要有过程标准、产品标准、行业标准、记法标准等。

过程标准与开发一个产品或从事一项服务的一系列活动或操作有关。

过程标准使用一组方法、工具和技术，给出“谁来做”、“做什么”、“如何做”、“何时做”、“何地做”及在软件工程活动中进行的不同层次工作的过程模型。

产品标准则涉及软件工程事务的格式和内容。

软件开发和维护活动文档化的结果就是软件产品，软件文档是软件工程活动进一步开展的基础。

软件开发作为一种行业，其行业标准涉及软件工程的所有方面，如职业认证、职业培训、产品许可等。

行业标准可以等同于行业行为规范。

记法标准规定了在软件工程行业范围内，以唯一的方式进行交流的方法，如术语、表示法、语言等。

它其实是一种语境规范。

二、按标准的范围划分：

按标准的范围划分主要是根据软件的任务功能和软件生存期进行比较、判定、评价和确定软件工程标准的范围和内容。

任务功能可以表示软件工程过程，可以划分为产品工程功能、验证与确认功能以及技术管理功能3个部分。

产品工程功能包括定义、生产和支持最终产品所必须的过程。

验证和确认功能是检查产品质量的活动。

技术管理功能是构造和控制产品工程的过程。

这3个部分并不集中在单个的软件生存周期里，而是并行进行的生产、检查和控制活动。

2.3软件文档的主要内容

文档编写标准化，在整个项目开发及使用过程中，应该有完备的文档支持，文档编制要求具有针对性、精确性、清晰性、完整性、灵活性和可追溯性。

完备的文档对软件的开发及使用起了很大的作用。

一般要求编写好十三种文档。

1、可行性分析报告

说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评述为了合理地达到开发目标可供选择的各种可能实施方案，说明并论证所选定实施方案的理由。

2、项目开发计划

为软件项目实施方案制订出具体计划，应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。

3、软件需求说明书（软件规格说明书）

对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。

它是在用户与开发人员双方对软件需求取得共同理解并达成协议的条件下编写的，也是实施开发工作的基础。

该说明书应给出数据逻辑和数据采集的各项要求，为生成和维护系统数据文件做好准备。

4、概要设计说明书

是概要设计阶段的工作总结。

主要包括功能分配、模块划分、程序总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理等，为详细设计作好准备。

5、详细设计说明书

着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。

6、用户操作手册

详细描述了该软件的功能、性能和用户界面，使用该软件的具体方法等。

7、测试计划

包括测试内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。

8、测试分析报告

测试计划的执行情况，对测试结果的分析，提出测试结论。

9、开发进度月报

按月提交的项目进展情况报告。

包括计划与实际执行情况的对比、阶段成果、遇到的问题、解决的方法以及下一步的打算。

10、项目开发总结报告

项目完成以后，总结实际执行情况。

如进度、成果、资源利用、成本和投入的人力，对项目开发作出评价，总结经验与教训。

11、软件维护手册

主要包括软件系统说明、程序模块说明、操作环境、支持软件说明、维护过程说明等。

12、软件问题报告

记录软件出现问题的日期、发现人、状态、问题所属模块等，为软件修改提供准备文档。

13、软件修改报告

软件产品投入使用后，发现了需修改、更正的问题，要将出现的问题、修改意见、修改可能出现影响作出详细描述，提交审批。

第3章实例

3.1兼职中介管理系统数据要求说明书实例

数据要求说明书（GB8567——88）

1引言

1.1编写目的

现在的在校大学生和刚刚步入社会的大学生需要一个平台找自己的一份工作，在校的学生想通过勤工俭学来帮家里减轻负担，通过这样的一个系统来，快捷的找寻工作。

古老的记录方法已经被信息化得社会取代，这样就可以实现简单快捷的记录。

1.2背景

当今时代是飞速发展的信息时代。

在各行各业中离不开信息处理，这正是计算机被广泛应用于信息管理系统的环境。

计算机的最大好处在于利用它能够进行信息管理。

使用计算机进行信息控制，不仅提高了工作效率，而且大大的提高了其安全性。

尤其对于复杂的信息管理，计算机能够充分发挥它的优越性。

计算机进行信息管理与信息管理系统的开发密切相关，系统的开发是系统管理的前提。

本系统就是为了管理好中介信息而设计的。

进入21世纪后，随着计算机在中介中的普及应用，以及计算机技术的不断发展，中介计算机系统的发展到了一个新的时期，新的系统平台、新的软件功能、新的系统特点及发展方向不断涌现.

目前，随着单位职工人员流动的不断增加，越来越多的应聘者和招聘者需要沟通，其中中介的作用是不可忽视的。

兼职中介系统是专门为大学生寻找兼职而开发的中介管理系统，其中包括找家教、网页制作、兼职软件开发等。

每一部分都包括招聘者信息和求职者信息以及招聘信息和求职信息的查询功能。

1.3定义

SQLServer：

StructuredQueryLanguageServer

1.4参考资料

郑人杰，殷人昆，陶永雷，《实用软件工程》，清华大学出版社，1997.

王珊著、数据库系统原理教程，清华大学出版社，2002.1

齐治昌等著、软件工程，高等教育出版社，2002.1

2数据的逻辑描述

数据进行逻辑描述分为动态和静态数据。

2.1静态数据

名字：

数据库文件

别名：

描述：

是网上书店系统的数据库。

是软件的核心数据库，有软件主窗体的所涉及的数据库。

定义：

数据库文件=教师信息+学生信息表+求职信息表+应聘信息表+系统信息表

位置：

系统磁盘存储器

名字：

教师信息

别名：

描述：

是兼职家教的学生的信息。

定义：

教师信息=教师编号+教师姓名+性别+年龄+籍贯+学校+专业+年级+职务+高考成绩+特长+爱好+联系电话+身份证号码+通信地址+当前状态+受理人+受理费用+学生编号+出生日期+等级日期

位置：

系统数据库

名称：

学生信息

别名：

描述：

记录需要家教授课的学生详细信息。

定义：

学生信息=学生编号+学生姓名+性别+年龄+学校+班级+平时成绩+学习状况+希望辅导课目+预期目标+家庭地址+联系电话+愿付报酬+联系人+身份证号码+状态+教师编号+受理人+收费+受理日期

位置：

系统数据库

名称：

求职信息

别名：

描述：

需要一份兼职工作的学生信息。

定义：

图书信息=收件号+学生姓名+性别+年龄+籍贯+学校+专业+年级+职务+特长+爱好+联系电话+身份证号码+通信地址+当前状态+受理人+受理费用+项目收件号+登记日期

位置：

系统数据库

名称：

招聘信息

别名

描述：

需要兼职工作的学生的公司信息。

定义：

图书订购=收件号+公司名称+软件类型+主要工作+工作地点+报酬+招聘对象+需要的技术+完成时间+联系人+联系电话+身份证号码+备注+受理人+受理费用+状态+学生收件号+登记日期

位置：

系统数据库

2.2动态输人数据

网页招聘元素（公司名称公司地址网站类型主要工作工作时间等）。

软件招聘元素（公司名称公司地址软件类型主要工作工作时间等）。

2.3动态输出数据

网页求职元素（学生姓名性别年龄学校专业等）。

软件求职元素（学生姓名性别年龄学校专业等）。

2.4内部生成数据

根据数据库各个表的内在连接关系可以生成新的所需要的数据，同时可以进行一些加权计算，例如个人信息，个人招聘信息，学生兼职项目等。

这些数据可以在SQL语句中体现。

2.5数据约定

对于数据库存储的信息

各种兼职信息报表中数据的输出有确定的形式，对于招聘，一般招工资保留至点后一位，加权分则保留至小数点后两位。

数据库要有严格有效的恢复机制；数据必须一个每天进行一次备份，由于信息量巨大，应以天为周期进行增量转储，以季度为周期进行海量转储。

所有的提交，确认，删除等操作以按钮的形式给出，且名称一律为取为“提交”、“确认”、“删除”等易于理解的形式。

数据的输入输出格式要求，参考需求规范的附录和成绩管理中的相关内容。

3数据的采集

3.1要求和范围

具体的内容包括：

数据的来源主要是建立数据库时录入的数据，在进行相应操作时会进行数据更新。

而不论是学生，教师，招聘人员都可以进行数据更新，数据可以在终端计算机上输入，也可在服务器上输入。

由于该系统是一个内部系统，所以在进行数据操作时会有一定的时延，或者页面打不开。

数据的输入采用统一的键盘输入，不需要其他的工具，但是数据是有一定的格式和密码限制的，所以输入不合法时会进入不了系统。

数据统一采用界面输入，接受者都是电脑，根据“提交”、“确认”、“删除”三个按钮，进入到数据库采用统一的处理。

数据的输出统一显示在界面上，一般采用表格的形式，必要时表格会打印输出。

打印机的选择采用统一的接口。

数据要及时更新，数据必须每天进行一次备份，由于信息量巨大，以天为周期进行增量转储，以季度为周期进行海量转储。

3.2输人的承担者

数据的输入可以是学生（查询兼职，修改信息等），教师（查询学生，修改信息等），招聘人员（发布信息，工资，修改招聘信息等）；输入数据基本都是采用键盘，易于控制。

数据的输入可以在界面也可以在数据库。

3.3预处理

兼职中介管理系统面向的使用者范围很广，在学期结束时，使用量尤其大，因此在数据流的控制上需要注意。

由于对于学生和教师的输入格式比较简单，因而不需要太注意。

兼职中介管理处理的信息格式多，需要进行简单转化。

在进行学生兼职的时候需要特别注意，访问量大，有可能造成系统崩溃，所以在选兼职时尽量分开安排学生选。

3.4影响

兼职中介管理系统是一个庞大的系统，有很大的数据存储，同时它的安全性也非常重要，不能透露私人信息，也不能随便乱改学生信息。

3.2兼职中介管理系统项目开发总结报告

项目开发总结报告（GB8567——88）

1引言

1.1编写目的

为了对这次项目开发的整个过程作一个全面的总结，对不足之处做进一步的修改，完善，使系统更完美，并从中吸取经验教训，特编写此项目开发总结报告。

1.2背景

尽管实验设计与优化的方法很多，但是由于其设计过程涉及的数据较多且算法复杂，采用传统的人工方法计算繁琐，工作量大，精度不高，基于计算机实现设计方法的软件很多，我们组提出开发一个实验设计小手。

软件名称：

兼职中介管理系统

项目提出者：

曲宸

开发者：

曲宸

需在windows的操作系统下运行。

1.3定义

SQLServer：

StructuredQueryLanguageServer

1.4参考资料

郑人杰，殷人昆，陶永雷，《实用软件工程》，清华大学出版社，1997.

王珊著、数据库系统原理教程，清华大学出版社，2002.1

齐治昌等著、软件工程，高等教育出版社，2002.1

2实际开发结果

2.1产品

图1兼职中介管理软件层次结构图

2.2主要功能和性能

本系统主要包括兼职中介管理，兼职查询，学生信息查询，兼职管理四个功能模块：

本软件的使用及功能:

一、兼职查询

采用完全可视化的方法将相同的招聘对象录入到数据库。

二、兼职管理

可视化是指每个学生以概率均等的原则分配到招聘组与兼职组。

2.3基本流程

1进入兼职中介管理系统

2选择使用的类型

3根据不同的需求进行不同的操作

4调试

5选择下一次使用的类型

6退出系统

2.4进度

系统规划阶段项标志性事件原计划进度实际进度时间差

开发阶段：

目开发计划书的完成11.21-11.2211.21-11.220天

需求分析阶段:

系统需求说明书完成11.23-11.2411.23-11.240天

设计阶段:

系统设计说明书11.25-11.2711.25-11.270天

编码实现:

项目的形成11.27-11.2711.27-11.28提前1天

测试阶段:

测试计划11.28-11.2911.28-11.290天

移交阶段:

项目的递交11.29-11.3011.29-11.29提前1天

比原计划提前了，主要原因：

①我们小组成员团队意识强，团结,工作态度积极，能力较强②系统功能较简单，开发过程中出现的问题比较少③小组成员编程经验比较丰富，时间比较紧。

2.5费用

无

3开发工作评价

3.1对生产效率的评价

给出实际生产效率，包括：

程序的平均生产效率，即每人月生产的行数；

文件的平均生产效率，即每人月生产的千字数；

并列出原订计划数作为对比。

3.2对产品质量的评价

出错发生率10％～15％。

产品基本达到了用户的原始需求。

3.3对技术方法的评价

运用了Microsoftvisualstudio2003软件，利用了C#的知识（循环，数组，界面设计，数据库）

3.4出错原因的分析

C#语言的使用不当，导致程序无法运行，但经反复调试后程序可以流畅运行

A．数据库定义中完整性约束与唯一性约束没有作出明确的定义导致数据库连接和获取数据出现错误。

B．数据库中的表之间的级联问题会导致对表的操作不便，比如要删除某个数据时会由于它与其它表之间的级联关系会删除不了等等一些问题。

4经验与教训

由于运用C#设计试验、项目做的太少，经验不足，遇到问题不能及时发现有效解决，对可能存在的风险不能做正确的预测考虑问题要全面，具体的问题要普遍化

第4章实训日记

第1天：

我们小组开始分配角色，每个成员都承担重要任务。

第2-3天：

我们小组去图书馆查阅了大量关于兼职中介管理系统软件工程文档的相关资料并在网上查找了一些关于软件工程设计的资料，要对每个细节要进行全面的设计和说明。

第4-6天：

我们小组开始整理从图书馆和网上收集来的资料和程序代码，分析模块功能，阅读软件工程书籍，对软件工程文档的撰写有了一定了解，了解对软件工程文档作用及分类并对其中内容整理到报告中，了解软件工程文档所采用的标准及分类并对内容整理到报告中，整理软件工程文档主要内容到报告中，完成报告实例一，对其中遇到的问题记录下来，然后通过从网上查资料找答案和大家共同研究探索解决，再完成实例一之后用同样的方式按部就班的进行着实例二的编写，再完成实例二之后，通过2周的实训，完成实训总结内容，总结这2周的收获。

第7天：

完成人力资源管理系统软件工程文档报告，上交作品。

第5章实训总结

本系统结构合理，简单明了，美观大方并能够快速、准确的响应客户所进行的操作，系统管理员能很好的对数据库进行录入、修改、删除、查询等操作，稳定性好，安全性优良。

使复杂繁琐的工作变得快捷简单，使房屋中介管理能够具体化、直观化、合理化。

应用本系统极大的提高了工作人员的工作效率，使每天的工作变得简单轻松，使管理更加科学化、智能化。

为期两周的实训就这样结束了这两周让我收获了不少。

本次实训主要有两个项目软件工程文档和生产实习。

当然其中还学习了画图等一些与自己专业关联的知识。

通过两周的实训，使我对软件工程文档知识有了进一步的了解，这是一次全面综合的训练。

我们通过学习《实用软件工程》这门课程，才可以成功的完成了这次课程设计，在实验过程中虽然遇到了很多问题，但是通过从图书馆里借来的资料和从网上查找的资料都把问题一一地解决了。

这次课程设计主要是让我们加深对软件工程文档写作基本知识的理解，掌握并运用软件工程文档写作来设计系统程序的基本方法及基本技巧。

这与我们平时学的知识息息相关，也有利于我们很好地把学会的知识应用到实践中去。

通过理论联系实际，巩固所学的知识，提高处理实际问题的能力，了解设计专题的主要内容，为毕业设计的顺利进行做好充分的准备，并为自己能顺利与社会环境接轨做准备。

参考文献

[1]王新颖《软件工程与文档编写》北京大学出版社2007.6

[2]郑人杰《实用软件工程（第4版）》清华大学出版社2003.4

[3]唐任仲《工程应用软件开发技术》化学工业出版社1999.5

[4]潘孝铭《软件文档编写》高等教育出版社2004.2

[5]肖刚《实用软件文档写作》清华大学出版社2008.