软件文档写作实训

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

1、辽 宁 工 业 大 学软件文档写作实训报告题目：兼职中介管理系统软件文档院（系）:教师职称：副教授起止时间：2012.11.26-2012.12.02实训任务及评语院（系）：软件学院 教研室：软件教研室学 号实训题目兼职中介管理系统软件文档实训任务实训任务及要求：1、 了解软件开发周期各阶段的文档。2、 掌握各文档阐述的内容及作用。3、 了解文档所采用的国际、国家等相关标准。4、 了解各文档所涉及的软件知识。5、 掌握各文档采用的描述工具。6、 具体编写出2个主要的软件文档。实训过程中，要严格遵守实训的时间安排，听从指导教师的指导。正确地完成上述内容，记录实习日记，规范完整地撰写出实训报告。几

2、个人为一组完成一个相对完整的软件系统开发文档，组内成员编写的文档不能重复，文档要严格按照所采用的标准编写，图表布局要合理规范。指导教师评语及成绩成绩： 指导教师签字： 年 月 日15 / 18目 录第1章实训目的与要求11.1 实训目的11.2 实训的实验环境11.3 实训的预备知识11.4 实训要求1第2章软件文档及其组成32.1软件文档的作用及分类32.2软件文档所采用的标准52.3 软件文档的主要内容5第3章实例73.1兼职中介管理系统软件需求说明书实例73.2 兼职中介管理系统数据库设计实例9第4章实训日记13第5章实训总结14参考文献15第1章 实训目的与要求1.1 实训目的本实训要

3、求学生通过具体的实例，模仿软件开发过程中软件文档写作的具体方法和步骤，分组完成一套较为简单软件文档，具体要达到以下几点目的。1、了解软件开发周期各阶段的文档。2、掌握各文档阐述的内容及作用。3、了解文档所采用的国际、国家等相关标准。4、了解各文档所涉及的软件知识。5、掌握各文档采用的描述工具。6、具体编写出2个主要的软件文件。1.2 实训的实验环境学校图书馆，互联网查询环境，具有软件图表制作软件的计算机。1.3 实训的预备知识 要求学生修完全部专科所有课程，具有较全面计算机软件知识和一定的文献检索能力及动手实践能力。该实训应安排在毕业设计之前进行。1.4 实训要求实训过程中，要严格遵守实训的时

4、间安排，听从指导教师的指导。正确地完成上述内容，记录实习日记，规范完整地撰写出实训报告。第2章 软件文档及其组成2.1软件文档的作用及分类软件文档可以分为开发文档和产品文档两大类。开发文档包括：功能要求、投标方案、需求分析、技术分析、系统分析、数据库文档、功能函数文档、界面文档、编译手册、QA文档、项目总结等。产品文档包括：产品简介、产品演示、疑问解答、功能介绍、 技术白皮书、评测报告、安装手册、使用手册、维护手册、 用户报告、销售培训等。一、开发文档：1. 功能要求-来源于客户要求和市场调查，是软件开发中最早期的一个环节。客户提出一个模糊的功能概念，或者要求解决一个实际问题，或者参照同类软件

5、的一个功能。有软件经验的客户还会提供比较详细的技术规范书，把他们的要求全部列表书写在文档中，必要时加以图表解说。这份文档是需求分析的基础。2. 投标方案-根据用户的功能要求，经过与招标方沟通和确认。3. 需求分析-包括产品概述、主要概念、操作流程、功能列表和解说、注意事项、系统环境等。4. 技术分析-包括技术选型、技术比较、开发人员、关键技术问题的解决、技术风险、技术升级方向、技术方案评价，竞争对手技术分析等。以需求分析为基础，进行详细的技术分析，列出本项目需要使用什么技术方案，有哪些技术问题要解决 ，估计开发期间会碰到什么困难，技术方案以后如何升级，对本项目的技术有什么评价等。5. 系统分析

6、-包括功能实现、模块组成、功能流程图、函数接口、数据字典、软件开发需要考虑的各种问题等。以需求分析为基础，进行详细的系统分析(产品的开发和实现方法)，估计开发期间需要把什么问题说明白，程序员根据系统分析，开始在项目主管的带领下进行编码。 6. 数据库文档-包括数据库名称、表名、字段名、字段类型、字段说明、备注、字段数值计算公式等。以系统分析为基础，进行详细的数据库设计。必要时可以用图表解说，特别是关系数据库。7. 功能函数文档-包括变量名、变量初植、功能，函数名，参数，如何调用、备注、注意事项等。以系统分析为基础，进行详细的说明，列出哪个功能涉及多少个函数，以便以后程序员修改、接手和扩展。8.

7、 界面文档-包括软件外观、界面素材、编辑工具、文件名、菜单、按钮和其它界面部件的要求，这里与软件完成后的运行界面是一致的。 9. 编译手册-包括服务器编译环境、操作系统、编译工具、GNU的C+编译器版本信息、目录说明、程序生成、源程序文件列表、Makefile配置及其相关程序的对应关系列表。10. QA文档-包括产品简介、产品原理、产品功能列表、功能描述、功能流程、执行结果、数据库结构、测试要求等，提供给软件测试人员使用。 11. 项目总结-包括项目简介、项目参与人员和开发时间、项目风险管理过程、项目功能列表、项目结构特点、技术特点、对项目的升级建议、对以后的项目的建议、人员素质情况等。二、产

8、品文档：1. 产品简介-包括公司背景、产品概念、适用范围、产品功能、功能特点、运行要求和公司联系地址。2. 产品演示-包括公司简介、产品背景、产品描述、产品特点、产品作用、适用范围、使用分析、功能模块、解决问题、合作伙伴、成功案例等。一般用Power、point或者VCD录制软件实现。3. 疑问解答-列出用户关心的问题和处理方法。用于解答软件的操作功能和解决用户的疑难问题。 4. 功能介绍-以需求分析为书写基础，包括软件介绍、软件结构、功能列表、功能描述和公司联系地址。5. 技术白皮书-以技术分析为书写基础，包括功能实现、技术选型、关键技术问题的解决、技术方案特点、技术升级方向等。6. 评测报

9、告-第三方权威评测报告。包括评测目的、评测范围、评测环境、评测内容、实测数据、性能表现、结果分析和评测总结等。7. 安装手册-包括系统环境、运行平台、产品安装过程、初始环境设置、安装记录等。8. 使用手册-包括产品简介、功能列表、功能描述和解释、功能操作、客户服务和联系方式等。9. 维护手册-包括产品简介、系统须知、初始环境设置、系统配置、数据管理和备份、技术问题解答和联系方式等。10. 用户报告-包括产品简介、购买时间、使用目的、使用时间、使用地点、实施过程、出现问题和解决、产品总结和建议等。11.销售培训-包括项目简介、产品功能、产品特点、商业优势、系统运行环境、适用范围、目标客户等。2.

10、2软件文档所采用的标准软件文档的标准分为国标8567-88和国标8567-2006，这连个标准分别是在1988年和2006年实施的。一、标准编号:GB/T 8567-1988 标准名称:计算机软件产品开发文件编制指南 标准状态:作废 英文标题:Guidelines for computer software product development documentation 替代情况:被GB/T 8567-2006代替 实施日期:1988-7-1颁布部门:国家标准局 内容简介:本指南是一份指导性文件。本指南建议，在一项计算机软件的开发过程中，一般地说，应该产生十四种文件。这十四种文件是：可行性

11、研究报告；项目开发计划；软件需求说明书；数据要求说明书；概要设计说明书；详细设计说明书；数据库设计说明书；用户手册；操作手册；模块开发卷宗；测试计划；测试分析报告；开发进度月报；项目开发总结报告。二、标准编号:GB/T 8567-2006 标准名称:计算机软件文档编制规范 标准状态:现行 英文标题:Specification for computer software documentation 替代情况:替代GB/T 8567-1988 实施日期:2006-7-1颁布部门:中华人民共和国国家质量监督检验检疫总局 中国国家标准化管理委员会 内容简介:本标准对软件的开发过程和管理过程应编制的主要

12、文档及其编制的内容、格式规定了基本要求。本标准原则上适用于所有类型的软件产品的开发过程和管理过程。2.3 软件文档的主要内容文档编写标准化，在整个项目开发及使用过程中，应该有完备的文档支持，文档编制要求具有针对性、精确性、清晰性、完整性、灵活性和可追溯性。完备的文档对软件的开发及使用起了很大的作用。一般要求编写好十三种文档。1、可行性分析报告说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评述为了合理地达到开发目标可供选择的各种可能实施方案，说明并论证所选定实施方案的理由。2、项目开发计划为软件项目实施方案制订出具体计划，应该包括各部分工作的负责人员、开发的进度、开发经费的预算、

13、所需的硬件及软件资源等。3、软件需求说明书（软件规格说明书）对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。它是在用户与开发人员双方对软件需求取得共同理解并达成协议的条件下编写的，也是实施开发工作的基础。该说明书应给出数据逻辑和数据采集的各项要求，为生成和维护系统数据文件做好准备。4、概要设计说明书是概要设计阶段的工作总结。主要包括功能分配、模块划分、程序总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理等，为详细设计作好准备。5、详细设计说明书着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。6、用户操作手册详细描述了该软件的功能、性能和用户界面，使用该软件

14、的具体方法等。7、测试计划包括测试内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。8、测试分析报告测试计划的执行情况，对测试结果的分析，提出测试结论。9、开发进度月报按月提交的项目进展情况报告。包括计划与实际执行情况的对比、阶段成果、遇到的问题、解决的方法以及下一步的打算。10、项目开发总结报告项目完成以后，总结实际执行情况。如进度、成果、资源利用、成本和投入的人力，对项目开发作出评价，总结经验与教训。11、软件维护手册主要包括软件系统说明、程序模块说明、操作环境、支持软件说明、维护过程说明等。12、软件问题报告记录软件出现问题的日期、发现人、状态、问题所属模块等，为软件修改提供准备文档。13、软件修改报告软件产品投入使用后，发现了需修改、更正的问题，要将出现的问题、修改意见、修改可能出现影响作出详细描述，提交审批。第3章 实例3.1兼职中介管理系统软件需求说明书实例软件需求说明书（GB856788）1引言1.1编写目的软件需要的功能为开发人员做好开发准备。读者为开发人员。1.2背景说明：软件系统名称：兼职中介管理系