文档的作用与分类

文档的作用与分类

软件文档(document)也称文件，通常指的是一些记录的数据和数据媒体，它具有固定不变的形式，可被人和计算机阅读。它和计算机程序共同构成了能完成特定功能的计算机软件(有人把源程序也当作文档的一部分)。我们知道，硬件产品和产品资料在整个生产过程中都是有形可见的，软件生产则有很大不同，文档本身就是软件产品。没有文档的软件，不成其为软件，更谈不到软件产品。软件文档的编制(documentation)在软件开发工作中占有突出的地位和相当的工作量。高效率、高质量地开发、分发、管理和维护文档对于转让、变更、修正、扩充和使用文档，对于充分发挥软件产品的效益有着重要意义。

然而，在实际工作中，文档在编制和使用中存在着许多问题，有待于解决。软件开发人员中较普遍地存在着对编制文档不感兴趣的现象。从用户方面看，他们又常常抱怨：文档售价太高、文档不够完整、文档编写得不好、文档已经陈旧或是文档太多，难于使用等等。究竟应该怎样要求它，文档应该写哪些，说明什么问题，起什么作用?这里将给出简要的介绍。

图1 文档桥梁作用

文档在软件开发人员、软件管理人员、维护人员、用户以及计算机之间的多种桥梁作用可从图1中看出。软件开发人员在各个阶段中以文档作为前阶段工作成果的体现和后阶段工作的依据，这个作用是显而易见的。软件开发过程中软件开发人员需制定一些工作计划或工作报告，这些计划和报告都要提供给管理人员，并得到必要的支持。管理人员则可通过这些文档了解软件开发项目安排、进度、资源使用和成果等。软件开发人员需为用户了解软件的使用、操作和维护提供详细的资料，我们称此为用户文档。以上三种文档构成了软件文档的主要部分。我们把这三种文档所包括的内容列在图2中。其中列举了十三个文档，这里对它们作一些简要说明：

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

项目开发计划：为软件项目实施方案制定出具体计划，应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。项目开发计划应提供给管理部门，并作为开发阶段评审的参考。

软件需求说明书：也称软件规格说明书，其中对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。它是用户与开发人员双方对软件需求取得共同理解基础上达成的协议，也是实施开发工作的基础。

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

文档

用户

文档

用户手册

操作手册

维护修改建议

软件需求（规格）说明书

开发

文档

软件需求（规格）说明书

数据要求说明书

概要设计说明书

详细设计说明书

可行性研究报告

项目开发计划

管理

文档

项目开发计划

测试计划

测试报告

开发进度月报

开发总结报告

图2 三种文档

概要设计说明书：该说明书是概要设计阶段的工作成果，它应说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等，为详细设计奠定基础。

详细设计说明书：着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。

用户手册：本手册详细描述软件的功能、性能和用户界面，使用户了解如何使用该软件。

操作手册：本手册为操作人员提供该软件各种运行情况的有关知识，特别是操作方法的具体细节。

测试计划：为做好组装测试和确认测试，需为如何组织测试制定实施计划。计划应包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。

测试分析报告：测试工作完成以后，应提交测试计划执行情况的说明。对测试结果加以分析，并提出测试的结论意见。

开发进度月报：该月报系软件人员按月向管理部门提交的项目进展情况报告。报告应包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的打算等。

项目开发总结报告：软件项目开发完成以后，应与项目实施计划对照，总结实际执行的情况，如进度、成果、资源利用、成本和投入的人力。此外还需对开发工作作出评价，总结出经验和教训。

维护修改建议：软件产品投入运行以后，发现了需对其进行修正、更改等问题，应将存在的问题、修改的考虑以及修改的影响估计作详细的描述，写成维护修改建议，提交审批。

以上这些文档是在软件生存期中，随着各阶段工作的开展适时编制。其中有的仅反映一个阶段的工作，有的则需跨越多个阶段。表3给出了各个文档应在软件生存期中哪个阶段编写。这些文档最终要向软件管理部门，或是向用户回答以下的问题：

表3 软件生存期各阶段编制的文档

哪些需求要被满足，即回答“做什么?”

所开发的软件在什么环境中实现以及所需信息从哪里来，即回答“从何处?” 某些开发工作的时间如何安排，即回答“何时干?”

某些开发(或维护)工作打算由“谁来干?”

某些需求是怎么实现的?

为什么要进行那些软件开发或维护修改工作?

上述十三个文档都在一定程度上回答了这六个方面的问题。这可从表4中看到。

表4 文档所回答的问题

至此，我们对文档的作用有了进一步的理解。每一个文档的任务也是明确的，任何一个文档都不是多余的。

软件文档种类

软件文档知多少？ 如今，软件开发越来越复杂，软件功能也越来越丰富。而几乎所有成熟的商业软件，都是靠一个开发团队齐心协力的血汗结晶。“罗马不是一天建成的！”，当我们震撼于Microsoft Windows的惊世巨著的同时，也道听途说了微软公司软件工程是如何的完善规范。的确，集数百名员工几年的共同努力之大成，软件项目管理的成败是控制开发成本的关键环节。这里面，少不了贯穿其中的重要步骤----软件文档。 软件文档可以分为开发文档和产品文档两大类。 开发文档包括：《功能要求》、《投标方案》、《需求分析》、《技术分析》、《系统分析》、《数据库文档》、《功能函数文档》、《界面文档》、《编译手册》、《QA文档》、《项目总结》等。 产品文档包括：《产品简介》、《产品演示》、《疑问解答》、《功能介绍》、《技术白皮书》、《评测报告》、《安装手册》、《使用手册》、《维护手册》、《用户报告》、《销售培训》等。 一、开发文档 1. 《功能要求》--来源于客户要求和市场调查，是软件开发中最早期的一个环节。客户提出一个模糊的功能概念，或者要求解决一个实际问题，或者参照同类软件的一个功能。有软件经验的客户还会提供比较详细的技术规范书，把他们的要求全部列表书写在文档中，必要时加以图表解说。这份文档是需求分析的基础。 2. 《投标方案》--根据用户的功能要求，经过与招标方沟通和确认，技术人员开始书写《投标方案》，方案书一般包括以下几个重要的章节： 前言--项目背景、公司背景和业务、技术人员结构、公司的成功案例介绍等。 需求分析--项目要求、软件结构、功能列表、功能描述、注意事项等。 技术方案--总体要求和指导思想、技术解决方案、软件开发平台、网络结构体系等。 项目管理--描述公司的软件开发流程、工程实施服务、组织和人员分工、开发进度控制、软件质量保证、项目验收和人员培训、软件资料文档等。

软件项目文档汇总

开发文档包括：《功能要求》、《投标方案》、《需求分析》、《技术分析》、《系统分析》、《数据库文档》、《功能函数文档》、《界面文档》、《编译手册》、《QA文档》、《项目总结》等。 产品文档包括：《产品简介》、《产品演示》、《疑问解答》、《功能介绍》、《技术白皮书》、《评测报告》、《安装手册》、《使用手册》、《维护手册》、《用户报告》、《销售培训》等。 一、开发文档 1. 《功能要求》--来源于客户要求和市场调查，是软件开发中最早期的一个环节。客户提出一个模糊的功能概念，或者要求解决一个实际问题，或者参照同类软件的一个功能。有软件经验的客户还会提供比较详细的技术规范书，把他们的要求全部列表书写在文档中，必要时加以图表解说。这份文档是需求分析的基础。 2. 《投标方案》--根据用户的功能要求，经过与招标方沟通和确认，技术人员开始书写《投标方案》，方案书一般包括以下几个重要的章节： 前言--项目背景、公司背景和业务、技术人员结构、公司的成功案例介绍等。 需求分析--项目要求、软件结构、功能列表、功能描述、注意事项等。 技术方案--总体要求和指导思想、技术解决方案、软件开发平台、网络结构体系等。 项目管理--描述公司的软件开发流程、工程实施服务、组织和人员分工、开发进度控制、软件质量保证、项目验收和人员培训、软件资料文档等。 技术支持--公司的技术支持和服务介绍、服务宗旨和目标、服务级别和响应时间、技术服务区域、技术服务期限、授权用户联系人等。系统报价--软、硬件平台报价列表、软件开发费用、系统维护费用等。 项目进度--整个项目的进度计划，包括签署合同、项目启动、需求分析、系统分析、程序开发、测试维护、系统集成、用户验收、用户培训等步骤的时间规划。

人物描写地分类及其作用(推荐)

人物描写的分类及其作用 一、人物描写的分类及作用： （一）分类：人物描写一般包括——外貌描写、语言描写、动作描写、心理描写、神态描写 注意：外貌描写不等于肖像描写，外貌描写包括了肖像描写。 肖像描写是指描绘一个人的相貌，主要是五官，也就是头部，比如说描写他的眼神。 而外貌描写的范围要大一点，着重描写一个人的气质，穿着，以及言谈举止。所以肖像描写不同于外 貌描写。 （二）描写的作用 1、外貌描写的作用：反映出人的喜好、身份、生活态度等,对塑造人物的性格和形象可以起烘托作用。 2、语言描写的作用：表现人物思想、品质和性格特点，揭示人物的身分与社会地位。 3、动作描写的作用：通过对人物个性化的行动、动作的描写，来揭示人物性格特点。 4、心理描写的作用：直接深入人物心灵，揭示人物的内心世界，表现人物丰富而复杂的思想感情。 5、神态描写的作用：表现人物内心世界，画人物性格，反应人物品质（此处请补充后边的练习） 阅读实践： 人物描写是指对人物的外貌、语言、动作、神态和心理活动等方面的描摹绘写。 一、外貌描写，是对人物的服饰、容貌等外部特征的描写。人的气质、精神、心理、感情的变化往往 凝聚在脸部表情上，所以“画脸”、“点睛”是外貌描写的重点。

文段（一） 阅读下面文段，回答问题。 这来的便是闰土。虽然我一见便知道是闰土，但又不是我这记忆上的闰土了。他身材增加了一倍；先前的紫色的圆脸，已经变作灰黄，而且加上了很深的皱纹；眼睛也像他父亲一样，周围都肿得通红，这我知道，在海边种地的人，终日吹着海风，大抵是这样的。他头上是一顶破毡帽，身上只一件极薄 的棉衣，浑身瑟索着；手里提着一个纸包和一支长烟管，那手也不是我所记得的红活圆实的手，却又 粗又笨而且开裂，像是松树皮了。 问：文段画横线的句子属于哪种人物描写方法？其作用是什么？ 答： 文段（二） 阅读下面文段，回答问题。 天使 1小时侯，我是一个捣蛋、不爱学习又极爱报复的孩子。无论在家里还是在学校，父母和老师、 兄弟和同学都极其厌恶我，然而，在心里我渴望着大家的关爱，就像人们渴望上帝的福泽一样。我一 个人独处的时候常常默默祈祷：上帝啊！给我善良、给我宽厚、给我聪明吧，我也想如卡尔列一样成 为同学们的榜样。可是，上帝正患耳疾，我的祈祷没有一句应验。我依然是个令人生厌的坏孩子，甚 至因为我，没有老师愿意带我们这个班。

人物描写的分类及其作用练习题及答案

一、外貌描写，是对人物的服饰、容貌等外部特征的描写。人的气质、精神、心理、感情的变化往往凝聚在脸部表情上，所以“画脸”、“点睛”是外貌描写的重点。 文段（一） 阅读下面文段，回答问题。 这来的便是闰土。虽然我一见便知道是闰土，但又不是我这记忆上的闰土了。他身材增加了一倍；先前的紫色的圆脸，已经变作灰黄，而且加上了很深的皱纹；眼睛也像他父亲一样，周围都肿得通红，这我知道，在海边种地的人，终日吹着海风，大抵是这样的。他头上是一顶破毡帽，身上只一件极薄的棉衣，浑身瑟索着；手里提着一个纸包和一支长烟管，那手也不是我所记得的红活圆实的手，却又粗又笨而且开裂，像是松树皮了。 问：文段画横线的句子属于哪种人物描写方法？其作用是什么？ 答： 文段（二） 阅读下面文段，回答问题。 天使 1小时侯，我是一个捣蛋、不爱学习又极爱报复的孩子。无论在家里还是在学校，父母和老师、兄弟和同学都极其厌恶我，然而，在心里我渴望着大家的关爱，就像人们渴望上帝的福泽一样。我一个人独处的时候常常默默祈祷：上帝啊！给我善良、给我宽厚、给我聪明吧，我也想如卡尔列一样成为同学们的榜样。可是，上帝正患耳疾，我的祈祷没有一句应验。我依然是个令人生厌的坏孩子，甚至因为我，没有老师愿意带我们这个班。 2三年级的第一个学期，学校里来了一位新老师，她就是年轻的玛丽娅小姐。玛丽娅小姐刚一站到讲台上，整个班里都沸腾了，她太漂亮啦！我带头吹口哨、飞吻、往空中仍书本，好多男生跟我学，我们的吵闹声几乎要把房顶掀开。 3玛丽娅小姐没有像其他老师那样大声叫嚷：“安静！安静！”她始终面带微笑地望着我们。奇怪，这样我反而感到很无聊，于是，我打一个手势，大家立即停止了胡闹。玛丽娅小姐开始自我介绍，当她转身想把自己地名字写到黑板上时，才发现讲桌上没有粉笔，我注意到她的眉头皱了一下很快又舒展了。心想；糟了，她肯定识破了我们的把戏。但是，玛丽娅小姐却转过身来问：“谁愿意替老师去拿盒粉笔？”刚刚平静下来的沸腾又开始了，怪声怪气的笑声再次淹没了整个教室，好多男生争着去干这件事。 4玛丽娅小姐请大家不要争，她会挑一个最合适的人选。玛丽娅走下讲台，仔细查看了每一个人，最后她说：“基恩，你去吧。”我说：“为什么是我？”“因为我看得出你热情、机灵又具号召力，我相信你会把事情做得很好。” 5我热情？我机灵？我具有号召力？我竟然有这么多优点？玛丽娅一眼就看出了我的优点！要知道，在此之前从未有人说过我哪怕一点点的好处，甚至我自己也认为我是一个被上帝抛弃的孩子。

开发文档介绍

开发文档介绍 软件开发文档是软件开发使用和维护过程中的必备资料。它能提高软件开发的效率，保证软件的质量，而且在软件的使用过程中有指导，帮助，解惑的作用，尤其在维护工作中，文档是不可或缺的资料。 软件文档可以分为开发文档和产品文档两大类。 开发文档包括：《功能要求》、《投标方案》、《需求分析》、《技术分析》、《系统分析》、《数据库文档》、《功能函数文档》、《界面文档》、《编译手册》、《QA 文档》、《项目总结》等。产品文档包括：《产品简介》、《产品演示》、《疑问解答》、《功能介绍》、《技术白皮书》、《评测报告》。用户文档《安装手册》、《使用手册》、《维护手册》、《用户报告》、《销售培训》等。 开发文档 1. 《功能要求》-- 来源于客户要求和市场调查，是软件开发中最早期的一个环节。 客户提出一个模糊的功能概念，或者要求解决一个实际问题，或者参照同类软件的一个功能。有软件经验的客户还会提供比较详细的技术规范书，把他们的要求全部列表书写在文档中，必要时加以图表解说。这份文档是需求分析的基础。 2. 《投标方案》-- 根据用户的功能要求，经过与招标方沟通和确认，技术人员开 始书写《投标方案》，方案书一般包括以下几个重要的章节：前言-- 项目背景、公司背景和业务、技术人员结构、公司的成功案例介绍等。需求分析-- 项目要求、软件结构、功能列表、功能描述、注意事项等。技术方案-- 总体要求和指导思想、技术解决方案、软件开发平台、网络结构体系等。项目管理-- 描述公司的软件开发流程、工程实施服务、组织和人员分工、开发进度控制、软件质量保证、项目验收和人员培训、软件资料文档等。技术支持-- 公司的技术支持和服务介绍、服务宗旨和目标、服务级别和响应时间、技术服务区域、技术服务期限、授权用户联系人等。系统报价-- 软、硬件平台报价列表、软件开发费用、系统维护费用等。项目进度-- 整个项目的进度计划，包括签署合同、项目启动、需求分析、系统分析、程序开发、测试维护、系统集成、用户验收、用户培训等步骤的时间规划。 3. 《需求分析》-- 包括产品概述、主要概念、操作流程、功能列表和解说、注意 事项、系统环境等。以《功能要求》为基础，进行详细的功能分析( 包括客户提出的要求和根据开发经验建议的功能) ，列出本产品是什么，有什么特殊的概念，包括哪些功能分类，需要具备什么功能，该功能的操作如何，实现的时候该注意什么细节，客户有什么要求，系统运行环境的要求等。这里的功能描述跟以后的使用手册是一致的。 4. 《技术分析》-- 包括技术选型、技术比较、开发人员、关键技术问题的解决、 技术风险、技术升级方向、技术方案评价，竞争对手技术分析等。以《需求分析》为基础，进行详细的技术分析( 产品的性能和实现方法) ，列出本项目需要使用什么技术方案，为什么，有哪些技术问题要解决，估计开发期间会碰到什么困难，技术方案以后如何升级，对本项目的技术有什么评价等。 5. 《系统分析》-- 包括功能实现、模块组成、功能流程图、函数接口、数据字典、 软件开发需要考虑的各种问题等。以《需求分析》为基础，进行详细的系统分析( 产

环境描写的类型和作用 (2)

环境描写的类型和作用 一、环境描写有两种类型： 小说是以人物为主要描写对象，那么作者一定要将人物置于一定空间和场所之中去展示性格，这便离不开一定的环境描写，读者据此可以看出小说中人物生活的时代风貌、社会制度及人与人之间的关系。 因此，在分析小说时，首先要从分析小说的典型环境入手，小说是怎样描写典型环境的，描写了什么样的典型性格，这种环境和作品中人物性格形成的关系，为分析人物的典型性格奠定了基础。 分析环境，一定要讲清环境所表达的时代的、地域的、民族的特点及环境所蕴涵的社会生活的广度和历史深度。 小说中的环境描写，有社会环境描写（社会背景）和自然环境描写。 自然环境描写，人们通常把它叫做景物描写。对日月星辰、山川河流、花草树木、鸟兽鱼虫、时序节令、风雨雪霜等自然景物的描写。 社会环境描写，是对一定历史时期的社会情态、生活风尚、风土人情的描写；在具体的文章中则指对人物的活动有影响的阶级关系、人际关系、居室陈设等环境因素的描写。主要作用是揭示时代背景，显示中心。这些描写能表现出人物性格的时代根源。 二、自然环境描写的作用 自然环境在文章中不是虚设的，就如同戏剧舞台的道具。它们总会在一定的时候发挥自己的作用。自然环境描写在不同的环境中，作用也会有所不同。 1、交代故事发生的时间、地点，季节、气候等。 2、交代自然环境的特点 3、交代人物身份，刻画人物心理，体现人物性格特征，如《祝福》中鲁四老爷的书房的描写：

我回到四叔的书房里时，瓦楞上已经雪白，房里也映得较光明，极分明的显出壁上挂着的朱拓的大“寿”字，陈抟老祖写的，一边的对联已经脱落，松松的卷了放在长桌上，一边的还在，道是“事理通达心气和平”。我又无聊赖的到窗下的案头去一翻，只见一堆似乎未必完全的《康熙字典》，一部《近思录集注》和一部《四书衬》。 小说对鲁四老爷书房中的陈设的描写，也很好地揭示了他肮脏的精神世界。壁上挂着的朱拓的大“寿”字，暗示着鲁四老爷希望自己能长寿，而他对祥林嫂的死活却漠然置之甚至深恶痛绝，怪祥林嫂死得不是时候；墙上的对联是“事理通达心气和平”，而他在祝福时得知祥林嫂惨死时，却勃然大怒，斥之为“谬种”，一句话就撕下了他伪善的假面具，暴露了他冷酷的心肠；而案头上摆的书籍，又说明他是一个地道的“讲理学的老监生”，是封建礼教的忠实维护者。 4、为事件的发生渲染气氛 在事件还没有发生之前，先渲染出一个气氛。 我们来看下面《鲈鱼奇缘》这一段文字，体会一下它的作用： 在鲈鱼钓猎开禁前的一天傍晚，他和妈妈早早又来钓鱼。安好诱饵后，他将鱼线甩向湖心，湖水在落日的余辉中荡起道道涟漪。当月升中天的时候，那波纹又变成了银白色的，景色十分优美。? 突然，钓竿的另一头儿沉了下去。他知道一定有大家伙上钩了，便急忙收起鱼线。母亲在一旁静静地看着儿子娴熟的动作。? 终于，孩子小心翼翼地把一条竭力挣扎的大鱼拉出水面。好大的鱼啊！在此之前他还没见过这么大的鱼呢。它是一条鲈鱼。? 第一段中的景物描写，表现了傍晚时分湖中美丽的景象，它带给人一种愉悦之感。这种美好的感觉与下文将要发生的故事带给人的感觉是一样的。 5、烘托人物的心情 人物的心情不同，所描写出的景物也就不同，请看《认识父亲?》

幼儿园：大班科学《按物体的用途分类》教学设计

新修订幼儿园阶段原创精品配套教材 大班科学《按物体的用途分类》教材定制 / 提高课堂效率 /内容可修改 Big class science "Classification by object use" 教师：风老师 风顺第二幼儿园 编订：FoonShion教育

大班科学《按物体的用途分类》 活动目标 1.能将物品按用途进行分类。 2.能正确表述自己的分类理由。活动准备 1.经验准备：幼儿已掌握物品用途的相关经验。 2.物质准备：若干实物，图谱标记、实物图片，分类盒，分类板等。活动过程一、以认识物品导入活动，激发幼儿的兴趣。二、整理物品，让幼儿初步学习按物品的用途分类。 1.引导幼儿将篮子里的物品，按照它们的特点分到篮子里的三个格子中，想想看可以怎么分。 2.分好后和同伴说说你的分类理由。 三、师观察幼儿操作并个别指导。四、师幼互动交流。师：谁来说说他是怎么分，为什么要把它们分在一起?五、运用图谱标记帮助幼儿梳理分类经验。 1.师：出示嘴巴、手、苹果、积木、汽车等标记卡，引导幼儿从中选出分别代表“吃的”“玩的”“用的”的标记。 2.师引导幼儿根据标记，将自己篮子里的物品按标记摆放好。六、分组练习，巩固按物品的用途分类。 1.介绍操作材料。 2.提出要求。 3.幼儿操作，师巡视指导。 4.师小结。教学反思在本次活动中主要是让幼儿能将物品按用途进行分类，并且

能正确表达自己的分类理由。在活动中，我首先以“认识物品”导入活动，并让幼儿“整理物品”，学习按物品的用途分类，幼儿个个都能将物品按食物、日用品和玩具等不同用途进行分类，也能说出分类的理由。接着引导幼儿运用图谱标记“送物品回家”，幼儿也都能将自己篮子里的物品按标记摆放好。可是在接下来的操作材料中，幼儿在给物品按标记分类中产生很大的分歧，有的标记相差非常细微，有很多小朋友容易看错，虽然在操作之前我有提示过了，但了解是一回事，真正做时有很大一部分幼儿不仔细观察标记，都分类错了。而这一切都反应出幼儿对画面的观察不够细心，做事太过于急促。进入大班以后，我发现有许多小朋友都对自己的行为缺乏信心，具体表现在：操作时总喜欢看别人的答案，甚至有的小朋友刚刚拿到操作材料就看别人是怎么做的，自己不爱动脑筋。要想从根本上增强幼儿的自信心，我觉得我们教师必须注意让幼儿真正掌握我们所要让他们掌握的，因为只有当他们真正懂了，学会了，才能做到心中有数，才能对自己产生认同感。另外，每节课结束以后，教师要做到及时反思、小结，及时的修改，累积经验，寻找幼儿更能接受的讲解方法，做到完善以及更好，让幼儿从兴趣开始培养，从根基开始打起，从基本习惯开始抓起，让幼儿喜爱上数学，喜爱上学习。 FoonShion教育研究中心编制

软件开发文档

如今，软件开发越来越复杂，软件功能也越来越丰富。而几乎所有成熟的商业软件，都是靠一个开发团队齐心协力的血汗结晶。“罗马不是一天建成的！”，当我们震撼于Microsoft Windows的惊世巨著的同时，也道听途说了微软公司软件工程是如何的完善规范。的确，集数百名员工几年的共同努力之大成，软件项目管理的成败是控制开发成本的关键环节。这里面，少不了贯穿其中的重要步骤----软件文档。 软件文档可以分为开发文档和产品文档两大类。 开发文档包括：《功能要求》、《投标方案》、《需求分析》、《技术分析》、《系统分析》、《数据库文档》、《功能函数文档》、《界面文档》、《编译手册》、《QA文档》、《项目总结》等。 产品文档包括：《产品简介》、《产品演示》、《疑问解答》、《功能介绍》、《技术白皮书》、《评测报告》、《安装手册》、《使用手册》、《维护手册》、《用户报告》、《销售培训》等。 一、开发文档 1. 《功能要求》--来源于客户要求和市场调查，是软件开发中最早期的一个环节。客户提出一个模糊的功能概念，或者要求解决一个实际问题，或者参照同类软件的一个功能。有软件经验的客户还会提供比较详细的技术规范书，把他们的要求全部列表书写在文档中，必要时加以图表解说。这份文档是需求分析的基础。 2. 《投标方案》--根据用户的功能要求，经过与招标方沟通和确认，技术人员开始书写《投标方案》，方案书一般包括以下几个重要的章节： 前言--项目背景、公司背景和业务、技术人员结构、公司的成功案例介绍等。 需求分析--项目要求、软件结构、功能列表、功能描述、注意事项等。 技术方案--总体要求和指导思想、技术解决方案、软件开发平台、网络结构体系等。 项目管理--描述公司的软件开发流程、工程实施服务、组织和人员分工、开发进度控制、软件质量保证、项目验收和人员培训、软件资料文档等。 技术支持--公司的技术支持和服务介绍、服务宗旨和目标、服务级别和响应时间、技术服务区域、技术服务期限、授权用户联系人等。 系统报价--软、硬件平台报价列表、软件开发费用、系统维护费用等。 项目进度--整个项目的进度计划，包括签署合同、项目启动、需求分析、系统分析、程序开发、测试维护、系统集成、用户验收、用户培训等步骤的时间规划。 3. 《需求分析》--包括产品概述、主要概念、操作流程、功能列表和解说、注意事项、系统环境等。以《功能要求》为基础，进行详细的功能分析(包括客户提出的要求和根据开发经验建议的功能)，列出本产品是什么，有什么特殊的概念，包括那些功能分类，需要具备什么功能，该功能的操作如何，实现的时候该注意什么细节，客户有什么要求，系统运行环境的要求等。这里的功能描述跟以后的使用手册是一致的。 4. 《技术分析》--包括技术选型、技术比较、开发人员、关键技术问题的解决、技术风险、技术升级方向、技术方案评价，竞争对手技术分析等。以《需求分析》为基础，进行详细的技术分析(产品的性能和实现方法)，列出本项目需要使用什么技术方案，为什么，有哪些技术问题要解决，估计开发期间会碰到什么困难，技术方案以后如何升级，对本项目的技术有什么评价等。 5. 《系统分析》--包括功能实现、模块组成、功能流程图、函数接口、数据字典、软件开发需要考虑的各种问题等。以《需求分析》为基础，进行详细的系统分析(产品的开发和实现方法)，估计开发期间需要把什么问题说明白，程序员根据《系统分析》，开始在项目主管的带领下进行编码。 6. 《数据库文档》--包括数据库名称、表名、字段名、字段类型、字段说明、备注、字段数值计算公式等。以《系统分析》为基础，进行详细的数据库设计。必要时可以用图表解说，特别是关系数据库。

景物描写的作用

景物描写的作用 一，景物描写的分类 （一）自然环境 （二）社会环境 片段一： 第二天我起得很迟，午饭之后，出去看了几个本家和朋友；第三天也照样。 他们也都没有什么大改变，单是老了些；家中却一律忙，都在准备着“祝福”。这是鲁镇年终的大典，致敬尽礼，迎接福神，拜求来年一年中的好运气的。杀鸡，宰鹅，买猪肉，用心细细的洗，女人的臂膊都在水里浸得通红，有的还带着绞丝银镯子。煮熟之后，横七竖八的插些筷子在这类东西上，可就称为“福礼”了，五更天陈列起来，并且点上香烛，恭请福神们来享用，拜的却只限于男人，拜完自然仍然是放爆竹。年年如此，家家如此，——只要买得起福礼和爆竹之类的——今年自然也如此。天色愈阴暗了，下午竟下起雪来，雪花大的有梅花那么大，满天飞舞，夹着烟霭和忙碌的气色，将鲁镇乱成一团糟。 我回到四叔的书房里时，瓦楞上已经雪白，房里也映得较光明，极分明的显出壁上挂着的朱拓的大“寿”字，陈抟老祖写的，一边的对联已经脱落，松松的卷了放在长桌上，一边的还在，道是“事理通达心气和平”。我又无聊赖的到窗下的案头去一翻，只见一堆似乎未必完全的《康熙字典》，一部《近思录集注》和一部《四书衬》。无论如何、我明天决计要走了。 ------------------《祝福》片段二： 晚会的日子到了，骆塞尔太太得到极大的成功，她比一般女宾都要漂亮，时髦，迷人，不断地微笑，并且乐得发狂。一般男宾都望着她出神，探听她的姓名，设法使人把自己引到她跟前作介绍。本部机要处的人员都想和她跳舞，部长也注意她。 ----------------《项链》片段三： 这日下晌，李中堂听过本地小曲莲花落子，饶有兴味，满心欢喜，撒泡热尿，身爽腹空，要吃点心。知府大人忙叫“杨七杨八”献上茶汤。今儿，两人自打到这世上来，头次里外全新，青裤青褂，白巾白袜，一双手拿碱面洗得赛脱层皮那样干净。他俩双双将茶汤捧到李中堂面前的桌上，然后一并退后五步，垂手而立，说是听候吩咐，实是请好请赏。 李中堂正要尝尝这津门名品，手指尖将碰碗边，目光一落碗中，眉头忽地一皱，面上顿起阴云，猛然甩手“啪”地将一碗茶汤打落在地，碎瓷乱飞，茶汤泼了一地，还冒着热气儿。在场众官员吓懵了，杨七和杨巴慌忙跪下，谁也不知中堂大人为嘛犯怒？ -------------------《好嘴杨巴》片段四：

软件项目文档

软件文档 文档的作用和分类 软件文档(document)也称文件，通常指的是一些记录的数据和数据媒体，它具有固定不变的形式，可被人和计算机阅读。它和计算机程序共同构成了能完成特定功能的计算机软件(有人把源程序也当作文档的一部分)。我们知道，硬件产品和产品资料在整个生产过程中都是有形可见的，软件生产则有很大不同，文档本身就是软件产品。没有文档的软件，不成其为软件，更谈不到软件产品。软件文档的编制(document ation)在软件开发工作中占有突出的地位和相当的工作量。高效率、高质量地开发、分发、管理和维护文档对于转让、变更、修正、扩充和使用文档，对于充分发挥软件产品的效益有着重要意义。 然而，在实际工作中，文档在编制和使用中存在着许多问题，有待于解决。软件开发人员中较普遍地存在着对编制文档不感兴趣的现象。从用户方面看，他们又常常抱怨：文档售价太高、文档不够完整、文档编写得不好、文档已经陈旧或是文档太多，难于使用等等。究竟应该怎样要求它，文档应该写哪些，说明什么问题，起什么作用?这里将给出简要的介绍。 图文档桥梁作用 文档在软件开发人员、软件管理人员、维护人员、用户以及计算机之间的多种桥梁作用可从图9．2中看出。软件开发人员在各个阶段中以文档作为前阶段工作成果的体现和后阶段工作的依据，这个作用是显而易见的。软件开发过程中软件开发人员需制定一些工作计划或工作报告，这些计划和报告都要提供给管理人员，并得到必要的支持。管理人员则可通过这些文档了解软件开发项目安排、进度、资源使用和成果等。软件开发人员需为用户了解软件的使用、操作和维护提供详细的资料，我们称此为用户文档。以上三种文档构成了软件文档的主要部分。我们把这三种文档所包括的内容列在图6中。其中列举了十三个文档，这里对它们作一些简要说明： ?可行性研究报告：说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评述为了合理地达到开发目标可供选择的各种可能实施的方案，说明并论证所选定实施方案的理由。 ?项目开发计划：为软件项目实施方案制定出具体计划，应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。项目开发计划应提供给管理部门，并作为开发阶段评审的参考。 ?软件需求说明书：也称软件规格说明书，其中对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。它是用户与开发人员双方对软件需求取得共同理解基础上达成的协议，也是实施开发工作的基础。 ?数据要求说明书：该说明书应给出数据逻辑描述和数据采集的各项要求，为生成和维护系统数据文卷作好准备。

软件文档写作课后题答案 (1)

百度文库- 让每个人平等地提升自我！ 软件文档写作习题集 上海第二工业大学计算机与信息学院 2012.6

软件文档写作习题 第1章 1.软件工程标准的划分方法有哪几种？每一种划分的主要内容是什么？ 按标准的类型划分按标准的范围划分 按标准的类型进行划分，主要有过程标准、产品标准、行业标准和记法标准。 按标准的范围进行划分，主要根据软件任务功能和软件生存周期进行标胶、判定、评价和确定软件工程标准的范围和内容。 2.软件工程标准按照标准的制定机构和适用范围分为哪几个层次？ 5个国际标准、国家标准、行业标准、企业标准、项目标准。 3.ISO 9000系列标准的内容是什么？ ISO 9000 质量管理和质量保证标准——选择和使用的导则 ISO 9001 质量体系——设计/开发、生产、安装和服务中的质量保证模式 ISO 9002 质量体系——生产和安装中的质量保证模式 ISO 9003 质量体系——最终检验和测试中的质量保证模式 ISO 9004 质量管理和质量体系要素——导则 4.ISO 9000-3对软件质量保证提出的要求主要包括哪些内容？ （1）合同审查 （2）需方的需求规格说明 （3）开发计划管理 （4）质量计划管理 （5）设计和实现 （6）测试和验证 （7）验收 （8）复制、交付和安装 （9）维护 （10）配置管理 （11）文档控制 （12）质量记录 （13）测量 （14）采购 （15）培训 （16）其他支持 第2章 1.软件文档的概念是什么？ 软件文档也称做软件文件，是一种重要的软件工程技术资料。例如技术文档、设计文档、版本说明文档。

2.软件文档的作用是什么？ 1）项目管理的依据 2）技术交流的语言 3）保证项目质量 4）培训与维护的资料 5）软件维护支持 6）记载软件历史的语言 3.软件文档按照文档产生和使用的范围是如何分类的？ 按照文档产生和使用的范围，软件文档可分为开发文档、用户文档、管理文档3类。 4.软件文档与使用对象的关系是什么？ 软件开发中产生的各类文档面向不同的使用对象，同时，软件用户应该得到的文档种类也应在供应者与用户之间签订的合同中明确规定。 5.软件文档编制与软件生存周期的关系是什么？ 一个计算机软件，从构思之日起，经过软件开发成功并投入使用，直到最后决定停止使用，并被另一个软件代替之时止，被认为是该软件的一个生命周期。一般来说，这个软件生存周期可以分成以下6个阶段：可行性研究与计划阶段、需求分析阶段、设计阶段、实现阶段、测试阶段、运行与维护阶段。 第3章 1.计算机软件产品的开发文档一般有多少种？分别是哪些文档？ 14种 1.可行性研究报告 2.项目开发计划 3.软件需求说明书 4.数据要求说明书 5.概要设计说明书 6.详细设计说明书 7.数据库设计说明书 8.用户手册 9.操作手册 10.模块开发卷宗 11.测试计划 12.测试分析报告 13.开发进度月报 14.项目开发总结报告 2.SRS文档编制的目标有哪些？对SRS文档的基本要求是什么？ （1）在软件产品完成目标方面为客户和开发者之间建立共同协议创立一个基础 （2）提高开发效率 （3）为成本计价和编制计划进度提供基础

GB 16680-1996 软件文档管理指南

GB/16680－1996软件文档管理指南 1 范围 本标准为那些对软件或基于软件的产品的开发负有职责的管理者提供软件文档的管理指南。本标准的目的在于协助管理者在他们的机构中产生有效的文档。 本标准涉及策略、标准、规程、资源和计划，管理者必须关注这些内容，以便有效地管理软件文档。 本标准期望应用于各种类型的软件，从简单的程序到复杂的软件系统。并期望覆盖各种类型的软件文档，作用于软件生存期的各个阶段。 不论项目的大小，软件文档管理的原则是一致的。对于小项目，可以不采用本标准中规定的有关细节。管理者可剪裁这些内容以满足他们的特殊需要。 本标准是针对文档编制管理而提出的，不涉及软件文档的内容和编排。 2 引用标准 下列标准所包含的条文，通过在本标准中引用而构成为本标准的条文。本标准出版时，所示版本均为有效，所有标准都会被修订，使用本标准的各方应探讨使用下列标准最新版本的可能性。 GB 8566-88 计算机软件开发规范 GB 8567-88 计算机软件产品开发文件编制指南 GB/T 11457-1995 软件工程术语 3 定义 本标准采用下列定义，其他定义见 GB/T 11457 。 3.1 文档 document 一种数据媒体和其上所记录的数据。它具有永久性并可以由人或机器阅读。通常仅用于描述人工可读的内容。例如，技术文件、设计文件、版本说明文件。 3.2 文档（集）；文档编制 documentation 一个或多个相关文档的集合。 3.3 文档计划 documentation plan 一个描述文档编制工作方法的管理用文档。该计划主要描述要编制什么类型的文档，这些文档的内容是什么，何时编写，由谁编写，如何编写，以及什么是影响期望结果的可用资源和外界因素。 3.4 文档等级 level of documentation 对所需文档的一个说明，它指出文档的范围、内容、格式及质量，可以根据项目、费用、预期用途、作用范围或其他因素选择文档等级。 3.5 软件产品 software product 软件开发过程的结果，并推出供用户使用的软件实体。 4 软件文档的作用 a) 管理依据； b) 任务之间联系的凭证； c) 质量保证； d) 培训与参考； e) 软件维护支持； f) 历史档案。 4.1 管理依据 在软件开过过程中，管理者必须了解开发进度、存在的问题和预期目标。每一阶段计划安排的定期报告提供了项目的可见性。定期报告还提醒各级管理者注意该部门对项目承担的

软件项目文档管理

软件项目文档管理 文档管理是项目管理中最关键的部分之一，文档管理的规范与否关系到项目进展状况，关系整个项目工作的效率与效益。抓住项目规范、文档规范，是推进公司发展的推动力。 一、文档管理的目标 文档管理的目标是将软件项目各阶段的各种文档资料（如各种图表、文字说明材料、数据文件、报告等）有效地进行组织、规划、归类，使文档的获得、归类、查找和提取更容易。最终目的就是使其成为软件项目中的一部分，与其他的项目内容构成完整的知识。 二、文档管理的作用及方法 1、文档管理的作用 软件文档也称文件，通常指的是一些记录的数据和数据媒体，它具有固定不变的形式，可被人和计算机阅读。它和计算机程序共同构成了能完成特定功能的计算机软件。文档本身就是软件产品，没有文档的软件，不成其为软件，更谈不到软件产品。软件文档的编制在软件开发工作中占有突出的地位和相当的工作量。高效率、高质量地开发、分发、管理和维护文档对于转让、变更、修正、扩充和使用文档，对于充分发挥软件产品的效益有着重要意义。 文档在软件开发人员、软件管理人员、维护人员、用户以及计算机之间的多种桥梁作用。软件开发人员在各个阶段中以文档作为前阶段工作成果的体现和后阶段工作的依据，这个作用是显而易见的。软件开发过程中软件开发人员需制定一些工作计划或工作报告，这些计划和报告都要提供给管理人员，并得到必要的支持。管理人员则可通过这些文档了解软件开发项目安排、进度、资源使用和成果等。软件开发人员需为用户了解软件的使用、操作和维护提供详细的资料，我们称此为用户文档。以上三种文档构成了软件文档的主要部分。 2、文档管理的方法 文档管理方法是最好有一套文档管理系统，作用：记录文档的变更、修改、增加、删除等操作情况，有效管理好软件项目各阶段的文档。为使用文档的人员提供了集中统一、安全的管理文档的渠道，实现了文档管理的电子化。 三、文档管理的任务 1、确定文档管理的范围 2、确定文档管理的内容和分类 3、记录文档的变更情况 4、建立编制、更改和维护文档的各种规程 5、不断检查已建立起来的过程，以保证符合各种规程并遵守有关标准和指南 6、在文档中存在商业秘密或技术秘密的情况下，还应注意保密 四、文档管理任务的实现 1、确定文档管理的范围 在一个软件项目中可能需要管理的文档有： （1）可行性研究报告：说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评述为了合理地达到开发目标可供选择的各种可能实施的方案，说明并论证所选定实施方案的理由。 （2）项目开发计划：为软件项目实施方案制定出具体计划，应该包括各部分

软件项目中涉及的文档分类和作用

软件项目中涉及的文档分类和作用 软件文档也称文件，通常指的是一些记录的数据和数据媒体，它具有固定不变的形式，可被人和计算机阅读。它和计算机程序共同构成了能完成特定功能的计算机软件(有人把源程序也当作文档的一部分)。我们知道，硬件产品和产品资料在整个生产过程中都是有形可见的，软件生产则有很大不同，文档本身就是软件产品。没有文档的软件，不成其为软件，更谈不到软件产品。软件文档的编制在软件开发工作中占有突出的地位和相当的工作量。高效率、高质量地开发、分发、管理和维护文档对于转让、变更、修正、扩充和使用文档，对于充分发挥软件产品的效益有着重要意义。 然而，在实际工作中，文档在编制和使用中存在着许多问题，有待于解决。软件开发人员中较普遍地存在着对编制文档不感兴趣的现象。从用户方面看，他们又常常抱怨：文档售价太高、文档不够完整、文档编写得不好、文档已经陈旧或是文档太多，难于使用等等。究竟应该怎样要求它，文档应该写哪些，说明什么问题，起什么作用?这里将给出简要的介绍。 图1：文档的桥梁作用 文档在软件开发人员、软件管理人员、维护人员、用户以及计算机之间的多种桥梁作用可从图1中看出。软件开发人员在各个阶段中以文档作为前阶段工作成果的体现和后阶段工作的依据，这个作用是显而易见的。软件开发过程中软件开发人员需制定一些工作计划或工作报告，这些计划和报告都要提供给管理人员，并得到必要的支持。管理人员则可通过这些文档了解软件开发项目安排、进度、资源使用和成果等。软件开发人员需为用户了解软件的使用、操作和维护提供详细的资料，我们称此为用户文档。以上三种文档构成了软件文档的主要部分。我们把这三种文档所包括的内容列在图2中。其中列举了十三个文档，这里对它们作一些简要说明： 文档用户 文档 用户手册 操作手册 维护修改建议 软件需求（规格）说明书 开发 文档 软件需求（规格）说明书 数据要求说明书 概要设计说明书 详细设计说明书 可行性研究报告 项目开发计划 管理 文档 项目开发计划 测试计划

人物描写的分类及其作用教师

第二讲人物描写的分类及其作用 一、人物描写的分类及作用： （一）分类：人物描写一般包括——外貌描写、语言描写、动作描写、心理描写、神态描写 注意：外貌描写不等于肖像描写，外貌描写包括了肖像描写。 肖像描写是指描绘一个人的相貌，主要是五官，也就是头部，比如说描写他的眼神。 而外貌描写的范围要大一点，着重描写一个人的气质，穿着，以及言谈举止。所以肖像描写不同于外貌描写。 （二）描写的作用 1、外貌描写的作用：反映出人的喜好、身份、生活态度等,对塑造人物的性格和形象可以起烘托作用。 2、语言描写的作用：表现人物思想、品质和性格特点，揭示人物的身分与社会地位。 3、动作描写的作用：通过对人物个性化的行动、动作的描写，来揭示人物性格特点。 4、心理描写的作用：直接深入人物心灵，揭示人物的内心世界，表现人物丰富而复杂的思想感情。 5、神态描写的作用：表现人物内心世界，画人物性格，反应人物品质 阅读实践： 人物描写是指对人物的外貌、语言、动作、神态和心理活动等方面的描摹绘写。 一、外貌描写，是对人物的服饰、容貌等外部特征的描写。人的气质、精神、心理、感情的变化往往凝聚在脸部表情上，所以“画脸”、“点睛”是外貌描写的重点。 文段（一） 阅读下面文段，回答问题。 这来的便是闰土。虽然我一见便知道是闰土，但又不是我这记忆上的闰土了。他身材增加了一倍；先前的紫色的圆脸，已经变作灰黄，而且加上了很深的皱纹；眼睛也像他父亲一样，周围都肿得通红，这我知道，在海边种地的人，终日吹着海风，大抵是这样的。他头上是一顶破毡帽，身上只一件极薄的棉衣，浑身瑟索着；手里提着一个纸包和一支长烟管，那手也不是我所记得的红活圆实的手，却又粗又笨而且开裂，像是松树皮了。 问：文段画横线的句子属于哪种人物描写方法？其作用是什么？ 答： 文段（二） 阅读下面文段，回答问题。 天使 1小时侯，我是一个捣蛋、不爱学习又极爱报复的孩子。无论在家里还是在学校，父母和老师、兄弟和同学都极其厌恶我，然而，在心里我渴望着大家的关爱，就像人们渴望上帝的福泽一样。我一个人独处的时候常常默默祈祷：上帝啊！给我善良、给我宽厚、给我聪明吧，我也想如卡尔列一样成为同学们的榜样。可是，上帝正患耳疾，我的祈祷没有一句应验。我依然是个令人生厌的坏孩子，甚至因为我，没有老师愿意带我们这个班。 2三年级的第一个学期，学校里来了一位新老师，她就是年轻的玛丽娅小姐。玛丽娅小姐刚一站到讲台上，整个班里都沸腾了，她太漂亮啦！我带头吹口哨、飞吻、往空中仍书本，好多男生跟我学，我们的吵闹声几乎要把房顶掀开。 3玛丽娅小姐没有像其他老师那样大声叫嚷：?安静！安静！?她始终面带微笑地望着我们。奇怪，这样我反而感到很无聊，于是，我打一个手势，大家立即停止了胡闹。玛丽娅小姐开始自我介绍，当她转身想把自己地名字写到黑板上时，才发现讲桌上没有粉笔，我注意到她的眉头皱了一下很快又舒展了。心想；糟了，她肯定识破了我们的把戏。但是，玛丽娅小姐却转过身来问：?谁愿意替老师去拿盒粉笔？?刚刚平静下来的沸腾又开始了，怪声怪气的笑声再次淹没了整个教室，好多男生争着去干这件事。 4玛丽娅小姐请大家不要争，她会挑一个最合适的人选。玛丽娅走下讲台，仔细查看了每一个人，最后她说：?基恩，你去吧。?我说：?为什么是我？??因为我看得出你热情、机灵又具号召力，我相信你会把事情做得很好。? 5我热情？我机灵？我具有号召力？我竟然有这么多优点？玛丽娅一眼就看出了我的优点！要知道，在此之前从未有人说过我哪怕一点点的好处，甚至我自己也认为我是一个被上帝抛弃的孩子。 6我很快取回一盒粉笔，因为它就藏在教室后面的草丛里。当我正要把粉笔递给玛丽娅小姐时，我发现我的手指甲逢里存满了污垢，衬衣袖口开了线，裤腿上溅满了污泥，更糟糕的是我五个脚趾全从破了口的鞋子里露出了头。我很不好意思，可玛丽娅小姐一点也不在意这些，她接粉笔的时候给了我一个天使般的微笑。玛丽娅就是上帝派来的天使。 7从此，我决定做一个上进、体面的人，因为我知道天使正在注视着我。 问：第6段对“我”运用了什么描写方法？这样描写的作用是什么？ 答：

软件文档的作用和分类

软件文档的作用和分类 软件文档(document)也称文件，通常指的是一些记录的数据和数据媒体，它具有固定不变的形式，可被人和计算机阅读。它和计算机程序共同构成了能完成特定功能的计算机软件(有人把源程序也当作文档的一部分)。我们知道，硬件产品和产品资料在整个生产过程中都是有形可见的，软件生产则有很大不同，文档本身就是软件产品。没有文档的软件，不成其为软件，更谈不到软件产品。软件文档的编制(documentation)在软件开发工作中占有突出的地位和相当的工作量。高效率、高质量地开发、分发、管理和维护文档对于转让、变更、修正、扩充和使用文档，对于充分发挥软件产品的效益有着重要意义。然而，在实际工作中，文档在编制和使用中存在着许多问题，有待于解决。软件开发人员中较普遍地存在着对编制文档不感兴趣的现象。从用户方面看，他们又常常抱怨：文档售价太高、文档不够完整、文档编写得不好、文档已经陈旧或是文档太多，难于使用等等。究竟应该怎样要求它，文档应该写哪些，说明什么问题，起什么作用?这里将给出简要的介绍。 图文档桥梁作用 文档在软件开发人员、软件管理人员、维护人员、用户以及计算机之间的多种桥梁作用可从图中看出。软件开发人员在各个阶段中以文档作为前阶段工作成果的体现和后阶段工作的依据，这个作用是显而易见的。软件开发过程中软件开发人员需制定一些工作计划或工作报告，这些计划和报告都要提供给管理人员，并得到必要的支持。管理人员则可通过这些文档了解软件开发项目安排、进度、资源使用和成果等。软件开发人员需为用户了解软件的使用、操作和维护提供详细的资料，我们称此为用户文档。 以上三种文档构成了软件文档的主要部分。我们把这三种文档所包括的内容列在图6中。其中列举了十三个文档，这里对它们作一些简要说明： ·可行性研究报告：说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评述为了合理地达到开发目标可供选择的各种可能实施的方案，说明并论证所选定实施方案的理由。 ·项目开发计划：为软件项目实施方案制定出具体计划，应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。项目开发计划应提供给管理部门，并作为开发阶段评审的参考。 ·软件需求说明书：也称软件规格说明书，其中对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。它是用户与开发人员双方对软件需求取得共同理解基础上达成的协议，也是实施开发工作的基础。 ·数据要求说明书：该说明书应给出数据逻辑描述和数据采集的各项要求，为生成和维护系统数据文卷作好准备。 ·概要设计说明书：该说明书是概要设计阶段的工作成果，它应说明功能分配、模块划