软件项目中涉及的文档分类和作用
软件文档也称文件，通常指的是一些记录的数据和数据媒体，它具有固定不变的形式，可被人和计算机阅读。它和计算机程序共同构成了能完成特定功能的计算机软件(有人把源程序也当作文档的一部分)。我们知道，硬件产品和产品资料在整个生产过程中都是有形可见的，软件生产则有很大不同，文档本身就是软件产品。没有文档的软件，不成其为软件，更谈不到软件产品。软件文档的编制在软件开发工作中占有突出的地位和相当的工作量。高效率、高质量地开发、分发、管理和维护文档对于转让、变更、修正、扩充和使用文档，对于充分发挥软件产品的效益有着重要意义。
然而，在实际工作中，文档在编制和使用中存在着许多问题，有待于解决。软件开发人员中较普遍地存在着对编制文档不感兴趣的现象。从用户方面看，他们又常常抱怨：文档售价太高、文档不够完整、文档编写得不好、文档已经陈旧或是文档太多，难于使用等等。究竟应该怎样要求它，文档应该写哪些，说明什么问题，起什么作用这里将给出简要的介绍。
图1：文档的桥梁作用
文档在软件开发人员、软件管理人员、维护人员、用户以及计算机之间的多种桥梁作用可从图1中看出。软件开发人员在各个阶段中以文档作为前阶段工作成果的体现和后阶段工作的依据，这个作用是显而易见的。软件开发过程中软件开发人员需制定一些工作计划或工作报告，这些计划和报告都要提供给管理人员，并得到必要的支持。管理人员则可通过这些文档了解软件开发项目安排、进度、资源使用和成果等。软件开发人员需为用户了解软件的使用、操作和维护提供详细的资料，我们称此为用户文档。以上三种文档构成了软件文档的主要部分。我们把这三种文档所包括的内容列在图2中。其中列举了十三个文档，这里对它们作一些简要说明：
文档用户
文档
用户手册
操作手册
维护修改建议
软件需求（规格）说明书开发
文档
软件需求（规格）说明书
数据要求说明书
概要设计说明书
详细设计说明书可行性研究报告项目开发计划
管理文档项目开发计划测试计划
测试报告
开发进度月报开发总结报告
图2：三种文档
可行性研究报告：说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评述为了合理地达到开发目标可供选择的各种可能实施的方案，说明并论证所选定实施方案的理由。项目开发计划：为软件项目实施方案制定出具体计划，应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。项目开发计划应提供给管理部门，并作为开发阶段评审的参考。
软件需求说明书：也称软件规格说明书，其中对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。它是用户与开发人员双方对软件需求取得共同理解基础上达成的协议，也是实施开发工作的基础。
数据要求说明书：该说明书应给出数据逻辑描述和数据采集的各项要求，为生成和维护系统数据文卷作好准备。
概要设计说明书：该说明书是概要设计阶段的工作成果，它应说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等，为详细设计奠定基础。
详细设计说明书：着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。
用户手册：本手册详细描述软件的功能、性能和用户界面，使用户了解如何使用该软件。
操作手册：本手册为操作人员提供该软件各种运行情况的有关知识，特别是操作方法的具体细节。
测试计划：为做好组装测试和确认测试，需为如何组织测试制定实施计划。计划应包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。
测试分析报告：测试工作完成以后，应提交测试计划执行情况的说明。对测试结果加以分析，并提出测试的结论意见。
开发进度月报：该月报系软件人员按月向管理部门提交的项目进展情况报告。报告应包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的打算等。
项目开发总结报告：软件项目开发完成以后，应与项目实施计划对照，总结实际执行的情况，如进度、成果、资源利用、成本和投入的人力。此外还需对开发工作作出评价，总结出经验和教训。
维护修改建议：软件产品投入运行以后，发现了需对其进行修正、更改等问题，应将存在的问题、修改的考虑以及修改的影响估计作详细的描述，写成维护修改建议，提交审批。以上这些文档是在软件生存期中，随着各阶段工作的开展适时编制。其中有的仅反映一个阶段的工作，有的则需跨越多个阶段。表1给出了各个文档应在软件生存期中哪个阶段编写。这些文档最终
阶段文档可行性要求与计划需求分析设计代码编写测试运行与维护
可行性研究报告
项目开发计划
软件需求说明
表1：软件生存期各阶段编制的文档
哪些需求要被满足，即回答“做什么”
所开发的软件在什么环境中实现以及所需信息从哪里来，即回答“从何处”
某些开发工作的时间如何安排，即回答“何时干”
某些开发(或维护)工作打算由“谁来干”
某些需求是怎么实现的
为什么要进行那些软件开发或维护修改工作
表2：文档所回答的问题
至此，我们对文档的作用有了进一步的理解。每一个文档的任务也是明确的，任何一个文档都不是多余的。
软件文档知多少？ 如今，软件开发越来越复杂，软件功能也越来越丰富。而几乎所有成熟的商业软件，都是靠一个开发团队齐心协力的血汗结晶。“罗马不是一天建成的！”，当我们震撼于Microsoft Windows的惊世巨著的同时，也道听途说了微软公司软件工程是如何的完善规范。的确，集数百名员工几年的共同努力之大成，软件项目管理的成败是控制开发成本的关键环节。这里面，少不了贯穿其中的重要步骤----软件文档。 软件文档可以分为开发文档和产品文档两大类。 开发文档包括：《功能要求》、《投标方案》、《需求分析》、《技术分析》、《系统分析》、《数据库文档》、《功能函数文档》、《界面文档》、《编译手册》、《QA文档》、《项目总结》等。 产品文档包括：《产品简介》、《产品演示》、《疑问解答》、《功能介绍》、《技术白皮书》、《评测报告》、《安装手册》、《使用手册》、《维护手册》、《用户报告》、《销售培训》等。 一、开发文档 1. 《功能要求》--来源于客户要求和市场调查，是软件开发中最早期的一个环节。客户提出一个模糊的功能概念，或者要求解决一个实际问题，或者参照同类软件的一个功能。有软件经验的客户还会提供比较详细的技术规范书，把他们的要求全部列表书写在文档中，必要时加以图表解说。这份文档是需求分析的基础。 2. 《投标方案》--根据用户的功能要求，经过与招标方沟通和确认，技术人员开始书写《投标方案》，方案书一般包括以下几个重要的章节： 前言--项目背景、公司背景和业务、技术人员结构、公司的成功案例介绍等。 需求分析--项目要求、软件结构、功能列表、功能描述、注意事项等。 技术方案--总体要求和指导思想、技术解决方案、软件开发平台、网络结构体系等。 项目管理--描述公司的软件开发流程、工程实施服务、组织和人员分工、开发进度控制、软件质量保证、项目验收和人员培训、软件资料文档等。
营销中心 项目文档管理制度版本信息：
一、目的 建立营销中心的文档管理制度，对项目中所有文档进行清晰有效的分类管理与控制，实现项目文档的有序保管与规范流动，为项目文档提供规范化的管理，提高项目的成功率，有效控制项目成本、进度、时间。 二、范围 本文适用于营销中心各单元、公司内配合部门及与之有关的客户、合资公司、渠道的文档。 三、原则 （一）定义 文档包括接收、发放和内部文档，含传真、电邮、备忘录或是会议纪要、邮递、商务运作阶段文档及其他内部文档。 （二）规范 1.明确内部文档的编制和命名 （1）文件名应是文件的标题。 （2）标题应能直观简明体现文件的内容。 （3）每个文档必须有一个统一的编号。 （4）在电子文档的命名后面加上编号。 （5）文件编制应使用对应的统一文档模板。 2.接收文档控制编号 所有接收文档需有统一文档控制编号，统一由文档中心管理。文档控制编号形式由项目管理者根据实际情况确定，建议体现接收日期的信息。 3.明确项目文档的使用制度
（1）在项目前，应建立一套文档的管理程序 明确文档的拟制、审核人员, 文档控制员。 明确所有文档的编号、收发登记操作，及受控等级。 （2）建议接收文档的管理程序 由文档控制员统一接收。 加盖或记录接收日期（时间）。 赋予文档控制编号。 记录输入文档中心数据库，保存原件。 （3）明确发送文档的管理程序 加盖或记录发送日期（时间）。 记录输入文档中心受控库，保存原件。 发送后由文档控制员统一记录归档。 （4）明确合同各方之间的文档传递等相关规定 （5）文档借阅登记和保密规定 原则上严禁文档原稿进行借阅。 借阅副本应进行登记，加盖副本章。 副本销毁的规定。 限期返还原件的规定。 （6）电子文档的共享规定 4.明确文档的归档存放 （1）建立纸面存储和电子件存储两套相对应的文档管理系统，目录结构见附表一《项目文档归档结构》。
开发文档包括：《功能要求》、《投标方案》、《需求分析》、《技术分析》、《系统分析》、《数据库文档》、《功能函数文档》、《界面文档》、《编译手册》、《QA文档》、《项目总结》等。 产品文档包括：《产品简介》、《产品演示》、《疑问解答》、《功能介绍》、《技术白皮书》、《评测报告》、《安装手册》、《使用手册》、《维护手册》、《用户报告》、《销售培训》等。 一、开发文档 1. 《功能要求》--来源于客户要求和市场调查，是软件开发中最早期的一个环节。客户提出一个模糊的功能概念，或者要求解决一个实际问题，或者参照同类软件的一个功能。有软件经验的客户还会提供比较详细的技术规范书，把他们的要求全部列表书写在文档中，必要时加以图表解说。这份文档是需求分析的基础。 2. 《投标方案》--根据用户的功能要求，经过与招标方沟通和确认，技术人员开始书写《投标方案》，方案书一般包括以下几个重要的章节： 前言--项目背景、公司背景和业务、技术人员结构、公司的成功案例介绍等。 需求分析--项目要求、软件结构、功能列表、功能描述、注意事项等。 技术方案--总体要求和指导思想、技术解决方案、软件开发平台、网络结构体系等。 项目管理--描述公司的软件开发流程、工程实施服务、组织和人员分工、开发进度控制、软件质量保证、项目验收和人员培训、软件资料文档等。 技术支持--公司的技术支持和服务介绍、服务宗旨和目标、服务级别和响应时间、技术服务区域、技术服务期限、授权用户联系人等。系统报价--软、硬件平台报价列表、软件开发费用、系统维护费用等。 项目进度--整个项目的进度计划，包括签署合同、项目启动、需求分析、系统分析、程序开发、测试维护、系统集成、用户验收、用户培训等步骤的时间规划。
项目文档管理制度
营销中心 项目文档管理制度版本信息：
一、目的 建立营销中心的文档管理制度，对项目中所有文档进行清晰有效的分类管理与控制，实现项目文档的有序保管与规范流动，为项目文档提供规范化的管理，提高项目的成功率，有效控制项目成本、进度、时间。 二、范围 本文适用于营销中心各单元、公司内配合部门及与之有关的客户、合资公司、渠道的文档。 三、原则 （一）定义 文档包括接收、发放和内部文档，含传真、电邮、备忘录或是会议纪要、邮递、商务运作阶段文档及其他内部文档。 （二）规范 1.明确内部文档的编制和命名 （1）文件名应是文件的标题。 （2）标题应能直观简明体现文件的内容。 （3）每个文档必须有一个统一的编号。 （4）在电子文档的命名后面加上编号。 （5）文件编制应使用对应的统一文档模板。 2.接收文档控制编号 所有接收文档需有统一文档控制编号，统一由文档中心管理。文档控制编号形式由项目管理者根据实际情况确定，建议体现接收日期的信息。 3.明确项目文档的使用制度
（1）在项目前，应建立一套文档的管理程序 ①明确文档的拟制、审核人员, 文档控制员。 ②明确所有文档的编号、收发登记操作，及受控等级。 （2）建议接收文档的管理程序 ①由文档控制员统一接收。 ②加盖或记录接收日期（时间）。 ③赋予文档控制编号。 ④记录输入文档中心数据库，保存原件。 （3）明确发送文档的管理程序 ①加盖或记录发送日期（时间）。 ②记录输入文档中心受控库，保存原件。 ③发送后由文档控制员统一记录归档。 （4）明确合同各方之间的文档传递等相关规定 （5）文档借阅登记和保密规定 ①原则上严禁文档原稿进行借阅。 ②借阅副本应进行登记，加盖副本章。 ③副本销毁的规定。 ④限期返还原件的规定。 （6）电子文档的共享规定 4.明确文档的归档存放 （1）建立纸面存储和电子件存储两套相对应的文档管理系统，目录结构见附表一《项目文档归档结构》。
如今，软件开发越来越复杂，软件功能也越来越丰富。而几乎所有成熟的商业软件，都是靠一个开发团队齐心协力的血汗结晶。“罗马不是一天建成的！”，当我们震撼于Microsoft Windows的惊世巨著的同时，也道听途说了微软公司软件工程是如何的完善规范。的确，集数百名员工几年的共同努力之大成，软件项目管理的成败是控制开发成本的关键环节。这里面，少不了贯穿其中的重要步骤----软件文档。 软件文档可以分为开发文档和产品文档两大类。 开发文档包括：《功能要求》、《投标方案》、《需求分析》、《技术分析》、《系统分析》、《数据库文档》、《功能函数文档》、《界面文档》、《编译手册》、《QA文档》、《项目总结》等。 产品文档包括：《产品简介》、《产品演示》、《疑问解答》、《功能介绍》、《技术白皮书》、《评测报告》、《安装手册》、《使用手册》、《维护手册》、《用户报告》、《销售培训》等。 一、开发文档 1. 《功能要求》--来源于客户要求和市场调查，是软件开发中最早期的一个环节。客户提出一个模糊的功能概念，或者要求解决一个实际问题，或者参照同类软件的一个功能。有软件经验的客户还会提供比较详细的技术规范书，把他们的要求全部列表书写在文档中，必要时加以图表解说。这份文档是需求分析的基础。 2. 《投标方案》--根据用户的功能要求，经过与招标方沟通和确认，技术人员开始书写《投标方案》，方案书一般包括以下几个重要的章节： 前言--项目背景、公司背景和业务、技术人员结构、公司的成功案例介绍等。 需求分析--项目要求、软件结构、功能列表、功能描述、注意事项等。 技术方案--总体要求和指导思想、技术解决方案、软件开发平台、网络结构体系等。 项目管理--描述公司的软件开发流程、工程实施服务、组织和人员分工、开发进度控制、软件质量保证、项目验收和人员培训、软件资料文档等。 技术支持--公司的技术支持和服务介绍、服务宗旨和目标、服务级别和响应时间、技术服务区域、技术服务期限、授权用户联系人等。 系统报价--软、硬件平台报价列表、软件开发费用、系统维护费用等。 项目进度--整个项目的进度计划，包括签署合同、项目启动、需求分析、系统分析、程序开发、测试维护、系统集成、用户验收、用户培训等步骤的时间规划。 3. 《需求分析》--包括产品概述、主要概念、操作流程、功能列表和解说、注意事项、系统环境等。以《功能要求》为基础，进行详细的功能分析(包括客户提出的要求和根据开发经验建议的功能)，列出本产品是什么，有什么特殊的概念，包括那些功能分类，需要具备什么功能，该功能的操作如何，实现的时候该注意什么细节，客户有什么要求，系统运行环境的要求等。这里的功能描述跟以后的使用手册是一致的。 4. 《技术分析》--包括技术选型、技术比较、开发人员、关键技术问题的解决、技术风险、技术升级方向、技术方案评价，竞争对手技术分析等。以《需求分析》为基础，进行详细的技术分析(产品的性能和实现方法)，列出本项目需要使用什么技术方案，为什么，有哪些技术问题要解决，估计开发期间会碰到什么困难，技术方案以后如何升级，对本项目的技术有什么评价等。 5. 《系统分析》--包括功能实现、模块组成、功能流程图、函数接口、数据字典、软件开发需要考虑的各种问题等。以《需求分析》为基础，进行详细的系统分析(产品的开发和实现方法)，估计开发期间需要把什么问题说明白，程序员根据《系统分析》，开始在项目主管的带领下进行编码。 6. 《数据库文档》--包括数据库名称、表名、字段名、字段类型、字段说明、备注、字段数值计算公式等。以《系统分析》为基础，进行详细的数据库设计。必要时可以用图表解说，特别是关系数据库。
软件项目中涉及的文档分类和作用 软件文档也称文件，通常指的是一些记录的数据和数据媒体，它具有固定不变的形式，可被人和计算机阅读。它和计算机程序共同构成了能完成特定功能的计算机软件(有人把源程序也当作文档的一部分)。我们知道，硬件产品和产品资料在整个生产过程中都是有形可见的，软件生产则有很大不同，文档本身就是软件产品。没有文档的软件，不成其为软件，更谈不到软件产品。软件文档的编制在软件开发工作中占有突出的地位和相当的工作量。高效率、高质量地开发、分发、管理和维护文档对于转让、变更、修正、扩充和使用文档，对于充分发挥软件产品的效益有着重要意义。 然而，在实际工作中，文档在编制和使用中存在着许多问题，有待于解决。软件开发人员中较普遍地存在着对编制文档不感兴趣的现象。从用户方面看，他们又常常抱怨：文档售价太高、文档不够完整、文档编写得不好、文档已经陈旧或是文档太多，难于使用等等。究竟应该怎样要求它，文档应该写哪些，说明什么问题，起什么作用?这里将给出简要的介绍。 图1：文档的桥梁作用 文档在软件开发人员、软件管理人员、维护人员、用户以及计算机之间的多种桥梁作用可从图1中看出。软件开发人员在各个阶段中以文档作为前阶段工作成果的体现和后阶段工作的依据，这个作用是显而易见的。软件开发过程中软件开发人员需制定一些工作计划或工作报告，这些计划和报告都要提供给管理人员，并得到必要的支持。管理人员则可通过这些文档了解软件开发项目安排、进度、资源使用和成果等。软件开发人员需为用户了解软件的使用、操作和维护提供详细的资料，我们称此为用户文档。以上三种文档构成了软件文档的主要部分。我们把这三种文档所包括的内容列在图2中。其中列举了十三个文档，这里对它们作一些简要说明： 文档用户 文档 用户手册 操作手册 维护修改建议 软件需求（规格）说明书 开发 文档 软件需求（规格）说明书 数据要求说明书 概要设计说明书 详细设计说明书 可行性研究报告 项目开发计划 管理 文档 项目开发计划 测试计划
软件文档 文档的作用和分类 软件文档(document)也称文件，通常指的是一些记录的数据和数据媒体，它具有固定不变的形式，可被人和计算机阅读。它和计算机程序共同构成了能完成特定功能的计算机软件(有人把源程序也当作文档的一部分)。我们知道，硬件产品和产品资料在整个生产过程中都是有形可见的，软件生产则有很大不同，文档本身就是软件产品。没有文档的软件，不成其为软件，更谈不到软件产品。软件文档的编制(document ation)在软件开发工作中占有突出的地位和相当的工作量。高效率、高质量地开发、分发、管理和维护文档对于转让、变更、修正、扩充和使用文档，对于充分发挥软件产品的效益有着重要意义。 然而，在实际工作中，文档在编制和使用中存在着许多问题，有待于解决。软件开发人员中较普遍地存在着对编制文档不感兴趣的现象。从用户方面看，他们又常常抱怨：文档售价太高、文档不够完整、文档编写得不好、文档已经陈旧或是文档太多，难于使用等等。究竟应该怎样要求它，文档应该写哪些，说明什么问题，起什么作用?这里将给出简要的介绍。 图文档桥梁作用 文档在软件开发人员、软件管理人员、维护人员、用户以及计算机之间的多种桥梁作用可从图9．2中看出。软件开发人员在各个阶段中以文档作为前阶段工作成果的体现和后阶段工作的依据，这个作用是显而易见的。软件开发过程中软件开发人员需制定一些工作计划或工作报告，这些计划和报告都要提供给管理人员，并得到必要的支持。管理人员则可通过这些文档了解软件开发项目安排、进度、资源使用和成果等。软件开发人员需为用户了解软件的使用、操作和维护提供详细的资料，我们称此为用户文档。以上三种文档构成了软件文档的主要部分。我们把这三种文档所包括的内容列在图6中。其中列举了十三个文档，这里对它们作一些简要说明： ?可行性研究报告：说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评述为了合理地达到开发目标可供选择的各种可能实施的方案，说明并论证所选定实施方案的理由。 ?项目开发计划：为软件项目实施方案制定出具体计划，应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。项目开发计划应提供给管理部门，并作为开发阶段评审的参考。 ?软件需求说明书：也称软件规格说明书，其中对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。它是用户与开发人员双方对软件需求取得共同理解基础上达成的协议，也是实施开发工作的基础。 ?数据要求说明书：该说明书应给出数据逻辑描述和数据采集的各项要求，为生成和维护系统数据文卷作好准备。
软件项目文档管理 文档管理是项目管理中最关键的部分之一，文档管理的规范与否关系到项目进展状况，关系整个项目工作的效率与效益。抓住项目规范、文档规范，是推进公司发展的推动力。 一、文档管理的目标 文档管理的目标是将软件项目各阶段的各种文档资料（如各种图表、文字说明材料、数据文件、报告等）有效地进行组织、规划、归类，使文档的获得、归类、查找和提取更容易。最终目的就是使其成为软件项目中的一部分，与其他的项目内容构成完整的知识。 二、文档管理的作用及方法 1、文档管理的作用 软件文档也称文件，通常指的是一些记录的数据和数据媒体，它具有固定不变的形式，可被人和计算机阅读。它和计算机程序共同构成了能完成特定功能的计算机软件。文档本身就是软件产品，没有文档的软件，不成其为软件，更谈不到软件产品。软件文档的编制在软件开发工作中占有突出的地位和相当的工作量。高效率、高质量地开发、分发、管理和维护文档对于转让、变更、修正、扩充和使用文档，对于充分发挥软件产品的效益有着重要意义。 文档在软件开发人员、软件管理人员、维护人员、用户以及计算机之间的多种桥梁作用。软件开发人员在各个阶段中以文档作为前阶段工作成果的体现和后阶段工作的依据，这个作用是显而易见的。软件开发过程中软件开发人员需制定一些工作计划或工作报告，这些计划和报告都要提供给管理人员，并得到必要的支持。管理人员则可通过这些文档了解软件开发项目安排、进度、资源使用和成果等。软件开发人员需为用户了解软件的使用、操作和维护提供详细的资料，我们称此为用户文档。以上三种文档构成了软件文档的主要部分。 2、文档管理的方法 文档管理方法是最好有一套文档管理系统，作用：记录文档的变更、修改、增加、删除等操作情况，有效管理好软件项目各阶段的文档。为使用文档的人员提供了集中统一、安全的管理文档的渠道，实现了文档管理的电子化。 三、文档管理的任务 1、确定文档管理的范围 2、确定文档管理的内容和分类 3、记录文档的变更情况 4、建立编制、更改和维护文档的各种规程 5、不断检查已建立起来的过程，以保证符合各种规程并遵守有关标准和指南 6、在文档中存在商业秘密或技术秘密的情况下，还应注意保密 四、文档管理任务的实现 1、确定文档管理的范围 在一个软件项目中可能需要管理的文档有： （1）可行性研究报告：说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评述为了合理地达到开发目标可供选择的各种可能实施的方案，说明并论证所选定实施方案的理由。 （2）项目开发计划：为软件项目实施方案制定出具体计划，应该包括各部分
软件文档的作用和分类 软件文档(document)也称文件，通常指的是一些记录的数据和数据媒体，它具有固定不变的形式，可被人和计算机阅读。它和计算机程序共同构成了能完成特定功能的计算机软件(有人把源程序也当作文档的一部分)。我们知道，硬件产品和产品资料在整个生产过程中都是有形可见的，软件生产则有很大不同，文档本身就是软件产品。没有文档的软件，不成其为软件，更谈不到软件产品。软件文档的编制(documentation)在软件开发工作中占有突出的地位和相当的工作量。高效率、高质量地开发、分发、管理和维护文档对于转让、变更、修正、扩充和使用文档，对于充分发挥软件产品的效益有着重要意义。然而，在实际工作中，文档在编制和使用中存在着许多问题，有待于解决。软件开发人员中较普遍地存在着对编制文档不感兴趣的现象。从用户方面看，他们又常常抱怨：文档售价太高、文档不够完整、文档编写得不好、文档已经陈旧或是文档太多，难于使用等等。究竟应该怎样要求它，文档应该写哪些，说明什么问题，起什么作用?这里将给出简要的介绍。 图文档桥梁作用 文档在软件开发人员、软件管理人员、维护人员、用户以及计算机之间的多种桥梁作用可从图中看出。软件开发人员在各个阶段中以文档作为前阶段工作成果的体现和后阶段工作的依据，这个作用是显而易见的。软件开发过程中软件开发人员需制定一些工作计划或工作报告，这些计划和报告都要提供给管理人员，并得到必要的支持。管理人员则可通过这些文档了解软件开发项目安排、进度、资源使用和成果等。软件开发人员需为用户了解软件的使用、操作和维护提供详细的资料，我们称此为用户文档。 以上三种文档构成了软件文档的主要部分。我们把这三种文档所包括的内容列在图6中。其中列举了十三个文档，这里对它们作一些简要说明： ·可行性研究报告：说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评述为了合理地达到开发目标可供选择的各种可能实施的方案，说明并论证所选定实施方案的理由。 ·项目开发计划：为软件项目实施方案制定出具体计划，应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。项目开发计划应提供给管理部门，并作为开发阶段评审的参考。 ·软件需求说明书：也称软件规格说明书，其中对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。它是用户与开发人员双方对软件需求取得共同理解基础上达成的协议，也是实施开发工作的基础。 ·数据要求说明书：该说明书应给出数据逻辑描述和数据采集的各项要求，为生成和维护系统数据文卷作好准备。 ·概要设计说明书：该说明书是概要设计阶段的工作成果，它应说明功能分配、模块划
序案卷题号名 一项目部分管理性册文件 项目工程文件资料的分类归档目录 目录 编归档分类名称细分名称 号 公司管理控制文件 （相关制度、重要文 1 件、通知、会议记录 等） 项目部岗位职责与分 2工表、管理人员约谈 记录表 项目部专业主管工程 3日志（项目工程交工 后整理成册） 4月度定期检查记录 项目部工程月报 项目年度管理总结 5总结性文件项目部员工月度、年度经营工作总结 项目后评估总结报告
行业主管部门 内部收发文记录表、工作联系单 1 函件 及其原文存档文件 通知 二收发文 监理单位 分管理文 施工单位 册件 分供方 外部收发文记录表、 2 工作联系单 及其原文存档文件 函件 通知 《建设用地规划许可证》 《建设工程规划许可证》 1 “五证”《建筑工程施工许可证》 《国有土地使用证》 《商品房销售（预售）许可证》三 报批报 分 2 建设占道手续 建资料 册 市政给排水、供电、 3 市政供暖手续
1例会纪要 四 会议纪 分 要资料 册 2专题会议纪要 3 专题报告
合同文件（施工合同、 监理合同、采购合同、 技术服务合同等、相 1 关补充 协议、合同阅读交底 记录） 五 分供方 招投标文件（监理单 分 管理 2 册位、总承包单位） 月度合作方履约交 3 底、评价表 1进度款申请表（月度）六成本管 分理类文 册件 甲供材料设备收（调） 2 料单
工程签证类文件（含3 台账） 扣款通知单（含业主4代付、某单独指定分包的工程等） 5奖/ 罚款通知单 6工程违约索赔通知单
1监理月报及审核意见 2整改通知单 七监理公 分司往来 册文件 3监理通知单 施工单位月报及审批 4 意见
■常见的几种应用软件及功能 Frontpage、Dreamweaver（html或htm、asp）：网页制作软件Excel（xls）：电子表格统计和制作软件 Access（mdb）：数据库管理软件 Powerpoint（ppt）：课件制作软件 Photoshop（psd）：图片编辑软件 flash（flc）：动画制作和编辑软件 Glodwave（wav）：声音编辑软件 会声会影（avi）：视频编辑软件 Word（doc）：文字编辑和处理软件 Internet Explorer（简称IE）：网页浏览器 Foxmail、Outlook Express：电子邮件收发软件Authorware：多媒体创作工具 Winrar（rar）：无损压缩软件 AcdSee：图片浏览工具 Windows media player：音频、视频播放器 ■数据文件格式及说明
■计算类型题目汇总 1、二进制转换成十六进制：从二进制的低位开始，每四位二进制数转换成一位十六进制数。反之，每一位十六进制数转换成四位二进制数。
2、黑白位图的图像所占空间大小计算。（单位：字节）： 因此黑白位图的图像大小计算公式为：水平像素点的个数×垂直像素点的个数/8。以一幅800×600像素的黑白图像为例，它所占的空间大小为：800×600（位），即800×600*1/8=60000字节。 3、常见的Wave文件所占磁盘的存储量计算公式为（单位：字节）： 存储量＝采样频率×量化位数×声道数×时间（秒）／8 例题：录制一个采样频率为44.1KHZ，量化位数为32，四声道立体环绕的w av格式音频数据40秒，需要的磁盘存储空间大约是多少？ 算式：44100×32×4×40/8=28224000（B）≈26.9（MB） 4、一段未经压缩的视频文件存储量的计算公式：（单位：字节）： 存储量=帧图像文件存储量×帧数×播放时间 5、二进制规则：n个比特位，可以表示2n个不同的信息单元 6、存储容量各单位之间的关系 ●1B＝8bit 1KB=1024B 1MB=1024KB 1GB=1024MB 1TB=1024GB ●1个汉字存储需要2个字节，除汉字外的所有字符只需1个字节。■常用的网络协议名词 Pop3：邮件接受协议Smtp：邮件发送协议 WWW： World Wide Web或简称为Web，中文译作万维网。传输WWW网页通常使用http协议。 URL：是指一个网页的地址。如：https://www.doczj.com/doc/453515568.html,/index.htm HTML：超文本标记语言，编写网页的语言 Ftp：文件传输协议 HTTP：超文本传输协议，浏览WWW网页时采用的协议。 BBS：电子公告板，又称论坛 ■算法与编程
软件文档可以分为开发文档和产品文档两大类： 开发文档包括：《功能要求》、《投标方案》、《需求分析》、《技术分析》、《系统分析》、《数据库文档》、《功能函数文档》、《界面文档》、《编译手册》、《QA文档》、《项目总结》等。 产品文档包括：《产品简介》、《产品技术白皮书》、《评测报告》、《安装手册》、《使用手册》、《维护手册》、《用户报告》、《销售培训》等。 一、开发文档 1. 《功能要求》——来源于客户要求和市场调查，是软件开发中最早期的一个环节。客户提出一个模糊的功能概念，或者要求解决一个实际问题，又或者是参照同类软件的一个功能。有软件经验的客户还会提供比较详细的技术规范书，把他们的要求全部列表书写在文档中，必要时加以图表解说。这份文档是需求分析的基础。 2. 《投标方案》——根据用户的功能要求，经过与招标方沟通和确认，技术人员开始书写《投标方案》，方案书一般包括前言、需求分析、技术方案、项目管理、技术支持、系统报价、项目进度等。 3. 《需求分析》——包括产品概述、主要概念、操作流程、功能列表、注意事项、系统环境等。以《功能要求》为基础，进行详细的功能分析，列出本产品是什么，有什么特殊的概念，包括那些功能分类，需要具备什么功能，该功能的操作如何，实现的时候该注意什么细节，客户有什么要求，系统运行环境的要求等。这里的功能描述跟以后的使用手册是一致的。 4. 《技术分析》——包括技术选型、技术比较、开发人员、关键技术问题的解决、技术风险、技术升级方向、技术方案评价，竞争对手技术分析等。以《需求分析》为基础，进行详细的技术分析（产品的性能和实现方法），列出本项目需要使用什么技术方案，为什么，有哪些技术问题要解决，估计开发期间会碰到什么困难，技术方案以后如何升级，对本项目的技术有什么评价等。 5. 《系统分析》——包括功能实现、模块组成、功能流程图、函数接口、数据字典、软件开发需要考虑的各种问题等。以《需求分析》为基础，进行详细的系统分析（产品的开发和实现方法），程序员根据《系统分析》，开始在项目主管的带领下进行编码工作。 6. 《数据库文档》——包括数据库名称、表名、字段名、字段类型、字段说明、备注、字段数值计算公式等。以《系统分析》为基础，进行详细的数据库设计，必要时可以用图表解说，特别是关系数据库。 7. 《功能函数文档》——包括变量名、变量初植、功能、函数名、参数、如何调用、备注、注意事项等。以《系统分析》为基础，进行详细的说明，列出哪个功能涉及多少个函数，以便以后程序员修改、接手和扩展。
项目管理档案管理规定 1、项目前期资料：①立项批文②地质勘探报告③工程质监、安监、人防等手续资料④图审合格证等材料⑤各类合同⑥招投标文件⑦规划许可证、用地许可证、施工许可证等； 2、项目管理文件：①项目部管理控制文件（项目部相关制度、项目部发文、中山保障房业主发文）②约谈记录③项目管理日志④项目管理联系单、通知单及回复单⑤罚款单等； 3、各类会议纪要：①项目管理部会议纪要（第一次工地例会会议纪要；项目管理部组织的协调会、交底会；专题例会会议纪要）②监理例会会议纪要③中山保障房业主组织的各类会议纪要等； 4、投资控制文件：①工程计量②工程签证③请款申请④合同外单价核定单⑤投资类管理文件⑥工程索赔申请等； 5、进度控制文件：①各类进度计划②工期签证等； 6、质量控制文件：①相关质量验收记录②项目管理部抽检资料③材料验收文件等； 7、设计类文件：①设计图纸②设计变更说明及图纸③图纸会审记录 ④竣工图⑤与设计单位的往来函件等； 8、监理往来文件：①开工报告、施工方案、施工组织设计②监理月报③监理方各类指令单④监理评估报告⑤分部（分项）验收记录⑥工作总结⑦竣工验收记录等； 9、安全文明控制文件：①现场安全文明类文件②现场安全巡查记录
等； 10、其他（包括现场相关配合单位资料、各主管部门发文及检查验收资料、影像照片资料等） 以上文件由本标段各安置房项目负责人按各保障房项目部（各施工合同项目）单独分开整理，竣工后移交于项目管理部办公室。档案盒及标签由项目管理部统一发放。所有的文件往来必须有收发文登记（收发文登记表由项目管理部统一制定），档案盒内需有卷内目录。 江苏建发建设项目咨询有限公司 南京溧水中山保障房项目管理部 2016年1月8日
一、目的 为了规范项目文档资料的管理工作，确保项目文档资料的系统性、完整性和准确性，充分发挥文档资料管理在项目中的作用，特制定本规定。 二、范围 本规定适用于项目开始直到项目结束的内外来往信函、会议纪要、备忘录、技术文件、管理文件、质量记录等所有与项目有关文件和资料的管理。 三、职责 3.1 项目经理 a) 负责组织制定项目文件的相关规定，对项目文件的控制负全责； b) 负责为项目文件和资料管理创造必要的条件。 3.2 综合管理经理 a) 负责项目文档资料相关规定的编制和监督检查； b) 负责编制项目文件和资料的编码规定； c) 负责组织项目结束后文档资料立卷、移交归档。 3.3 分项经理
a) 负责本部门的文档资料的管理； b) 负责本部门项目结束后文档资料的移交。 3.4 文控管理工程师 a) 配合综合管理经理制定项目文档资料管理规定并监督检查； b) 负责项目文件和资料的接收、分类、登记、传递、发放等； c) 负责项目实施阶段文档资料收集、整理、编目及归档工作； d) 负责项目结束后项目文档资料立卷、移交。 4 管理要求和方法 4.1 一般规定 项目文档资料的管理应从项目申请立项到竣工验收的全过程，项目经理部各分项经理应在职责范围内对项目实施过程中所形成的文件、图纸、资料，随时进行积累整理、立档和保管，并采取必要措施，防止档案资料的损毁和遗失以及有关保密档案资料的泄密。 4.2 文档分类及编号 4.2.1 项目文件分类 4.2.1.1 项目信息文件
项目信息文件指项目实施过程中传递的任何书面信息文件。 a) 来往信件、传真； b) 备忘录； c) 会议纪要； d) 文件传送单。 4.2.1.2 项目管理文件 项目管理文件指项目运行过程中必须编写的管理文件。 a) 项目协调程序； b) 项目进度与费用控制程序； c) 项目质量保证手册； d) 项目资源配置手册等。 4.2.1.3 项目技术文件 项目技术文件指按照合同要求，项目技术人员完成的各种设计文件及图纸等。 4.2.1.4 项目其它文件
营销中心 项目文档管理制度版本信息:
一、目的 建立营销中心的文档管理制度，对项目中所有文档进行清晰有效的分类管理与控制，实现项目文档的有序保管与规范流动，为项目文档提供规范化的管理，提高项目的成功率，有效控制项目成本、进度、时间。 二、范围 本文适用于营销中心各单元、公司内配合部门及与之有关的客户、合资公司、渠道的文档。 三、原则 （一）定义 文档包括接收、发放和内部文档，含传真、电邮、备忘录或是会议纪要、邮递、商务运作阶段文档及其他内部文档。 （二）规范 1.明确内部文档的编制和命名 （1）文件名应是文件的标题。 （2）标题应能直观简明体现文件的内容。 （3）每个文档必须有一个统一的编号。 （4）在电子文档的命名后面加上编号。 （5）文件编制应使用对应的统一文档模板。 2.接收文档控制编号 所有接收文档需有统一文档控制编号，统一由文档中心管理。文档控制编号形式由项目管理者根据实际情况确定，建议体现接收日期的信息。 3.明确项目文档的使用制度
（1）在项目前，应建立一套文档的管理程序 明确文档的拟制、审核人员，文档控制员。 明确所有文档的编号、收发登记操作，及受控等级。 （2）建议接收文档的管理程序 由文档控制员统一接收。 加盖或记录接收日期（时间）。 赋予文档控制编号。 记录输入文档中心数据库，保存原件。 （3）明确发送文档的管理程序 加盖或记录发送日期（时间）。 记录输入文档中心受控库，保存原件。 发送后由文档控制员统一记录归档。 （4）明确合同各方之间的文档传递等相关规定 （5）文档借阅登记和保密规定 原则上严禁文档原稿进行借阅。 借阅副本应进行登记，加盖副本章。 副本销毁的规定。 限期返还原件的规定。 （6）电子文档的共享规定 4.明确文档的归档存放 （1）建立纸面存储和电子件存储两套相对应的文档管理系统, 附表一 目录结构见《项目文档归档结构》
软件文档： 开发文档：《功能要求》《投标方案》《需求分析》《技术分析》《系统分析》《数据库文档》《功能函数文档》《界面文档》《编译手册》《QA文档》《项目总结》等 产品文档：《产品简介》《产品演示》《疑问解答》《功能介绍》《技术白皮书》《评测报告》《安装手册》《使用手册》《维护手册》《用户报告》《销售培训》 开发文档： 《功能要求》：来源于客户要求和市场调查，是软件开发中最早期的一个环节。客户提出一个模糊的功能概念，或者要求解决一个实际的问题，或者参照同类软件的一个功能。有软件经验的客户还会提出比较详细的技术规范书，把他们的要求全部列表书写在文档中，必要时加以图表解说。这份文档时需求分析的基础。 《投标方案》根据用户的功能要求，经过与招标方沟通和确认，技术人员开始书写《投标方案》，方案书一般包括以下几个重要的章节： 前言：项目背景、公司背景和业务、技术人员结构、公司的成功案例介绍等。 需求分析：项目要求、软件结构、功能列表、功能描述、注意事项等。 技术方案：总体要求和指导思想、技术解决方案、软件开发平台、网络结构体系等。 项目管理：描述公司的软件开发流程、工程实施服务、组织和员工分工、开发进度控制、软件质量保证、先后木验收和人员培训、软件资料文档等。 技术支持：公司的技术支持和服务介绍、服务宗旨和目标、服务级别和响应时间、技术服务区域、技术服务期限、授权用户联系人等。 系统报价：软硬件平台报价列表、软件开发费用、系统维护费用等 项目进度：整个项目的进度计划，包括签署合同、项目启动、需求分析、系统分析、程序开发、测试维护、系统集成、用户验收、用户培训等步骤的时间规划。 《需求分析》包括产品概述、主要概念、操作流程、功能列表和解说、注意事项系统环境等。以《功能要求》为基础，进行详细的功能分析（包括客户提出的要求和根据开发经验建议功能），列出本产品是什么，有什么特殊的概念，包括那些功能的分类，需要具备什么功能，该功能的操作如何，实现的时候该注意什么细节，客户有什么要求，系统运行环境的要求等。这里的功能跟描述跟以后的使用手册是一致的。 《技术分析》包括技术选型、技术比较、开发人员、关键技术问题的解决、技术风险、技术升级方向、技术方案评价，竞争对手技术分析等。以《需求分析》为基础，进行详细的技术分析（产品的性能和实现方法），列出本项目需要使用什么技术方案，为什么，有哪些技术问题要解决，估计开发期间会碰到什么困难，技术方案以后如何升级，对本项目的技术有什么评价等。 《系统分析》：包括功能实现，模块组成、功能流程图、函数接口、数据字典、软件开发需要考虑的各种问题等。以《需求分析》为基础，进行详细的系统分析（产品的开发和实现方法），估计开发期间需要把什么问题说明白，程序员根据《系统分析》，开始在项目主管的带领下进行编码。
公司文件的分类 A、一级分类：按照各部门所产生的不同性质的文件分为十个部门，以各部门的字母来代表（公司编号表） 企管部：QGB 总经理办公室： 人力资源部： 市场管理部： 项目发展部： 证券投资部： 法律事务部： 信息资源管理中心： 审计部： 发展策划部： 招标管理部： 党工部： 采购部： 科技管理部： 财务部： 保卫部： 管理方法： 1、按照公司领导分管部门，将各部门所产生的报告、请示等文件，均递交至总经办，总经办也将采取专人负责各高管，对口将各部门文件产生文件，统一进行编号、登记、传递，以此方式达到工作对口负责、专人检查落实的目的。 B、二级分类：按照文件类型划分: 一级类目：公司所有资产证据类（A表示） A1：合同、协议 A2：公司章程、验资报告、账号、授权书、许可证、资产移交等 二级类目：公文类( B) B1：令、决定、议案：适用于对重要事项或者重大行动作出安排，如：各级人民政府的下发的强制性行政措施、本公司董事会决议、股东会会议纪要等 B2：公告；通告；通报：使用与宣布或公布重要事项或应当遵守获证周知的事项，如：上级机构下发的法定事项、社会公告、表彰先进、批评错误、规章制度等 B3：请示、皮肤：适用于向上级机关请示指示、批准，答复下级机关的请示事项B4：报告、意见：适用于想上级机关汇报工作，，对重要问题提出见解和处理办
法 B5：通知、函：适用于批转下级的公文，传达要求下级机关办理和需要有关单位周知或者执行的事项，不相隶属的单位之间商洽工作、询问和问题，如：任免人员等 B6：会议纪要：适用于记载、传达会议情况和议定事项 三级类目：普通文件类（C），其他一般性文件 四级类目：非文本载体的文件（D），如照片、软盘及其他声像资料等 按照文件受控类型主要分为受控文档与非受控文档，各类资产证据、秘密文件的原件原则上均属于受控文档，复印件原则上均属于非受控文档，在受控文件的编号前加K表示，不加均默认为非受控证件 C、三级分类：按照文件年度划分，以年月的数字代号表示，如0310代表2003年10月 D、四级分类：文件的原件Manuscript、复印件Copy分别以英文的第一个字母代表，如原件用M表示、复印件用C表示 以上为一般情况，有项目文件存在的情况下，项目文件单独存放，若项目多，种类也多，则按照项目分类。
软件文档知多少? 如今，软件开发越来越复杂,软件功能也越来越丰富。而几乎所有成熟的商业软件,都是靠一个开发团队齐心协力的血汗结晶。“罗马不是一天建成的!”，当我们震撼于Microsof ｔWｉｎdows的惊世巨著的同时，也道听途说了微软公司软件工程是如何的完善规范。的确,集数百名员工几年的共同努力之大成,软件项目管理的成败是控制开发成本的关键环节。这里面,少不了贯穿其中的重要步骤----软件文档。 软件文档可以分为开发文档和产品文档两大类。 开发文档包括:《功能要求》、《投标方案》、《需求分析》、《技术分析》、《系统分析》、《数据库文档》、《功能函数文档》、《界面文档》、《编译手册》、《ＱA文档》、《项目总结》等。 产品文档包括:《产品简介》、《产品演示》、《疑问解答》、《功能介绍》、《技术白皮书》、《评测报告》、《安装手册》、《使用手册》、《维护手册》、《用户报告》、《销售培训》等。 一、开发文档 1. 《功能要求》--来源于客户要求和市场调查,是软件开发中最早期的一个环节。客户提出一个模糊的功能概念,或者要求解决一个实际问题,或者参照同类软件的一个功能。有软件经验的客户还会提供比较详细的技术规范书,把他们的要
求全部列表书写在文档中，必要时加以图表解说。这份文档是需求分析的基础。 2. 《投标方案》--根据用户的功能要求,经过与招标方沟通和确认,技术人员开始书写《投标方案》，方案书一般包括以下几个重要的章节: 前言-－项目背景、公司背景和业务、技术人员结构、公司的成功案例介绍等。 需求分析－-项目要求、软件结构、功能列表、功能描述、注意事项等。 技术方案－-总体要求和指导思想、技术解决方案、软件开发平台、网络结构体系等。 项目管理－-描述公司的软件开发流程、工程实施服务、组织和人员分工、开发进度控制、软件质量保证、项目验收和人员培训、软件资料文档等。 技术支持-－公司的技术支持和服务介绍、服务宗旨和目标、服务级别和响应时间、技术服务区域、技术服务期限、授权用户联系人等。 系统报价-－软、硬件平台报价列表、软件开发费用、系统维护费用等。 项目进度--整个项目的进度计划,包括签署合同、项目启动、需求分析、系统分析、程序开发、测试维护、系统集成、用户验收、用户培训等步骤的时间规划。
设计文档的功能 一份设计文档应从如下包含几个方面说明： ●模块划分 ●信息规格 ●工作流程 ●角色定义、安全保密控制 ●信息管理功能 ●数据库结构 ●用户操作方式
设计文档的组成 1.1.信息对象 对本系统所管理的全部信息的概况性分类和定义。 格式（树型目录）： 信息对象名称：描述（若信息对象简单明了可以省略描述 信息对象的属性构成 1.2.工作岗位 对可以访问本系统的所有用户的概况性分类和定义，“工作岗位”是规范化工作流程和安全保密控制的基础。角色可以分为静态（指相当稳定的工作岗位，主要反映企业内员工级别的划分。）和动态（指日常工作中的各种临时性任命）两种。 格式（树型目录）： 静态岗位 岗位1 包括：此岗位对应的人员 〖权限〗 ●从读、创建、修改、删除四个方面描述 动态岗位 同静态岗位 1.3.工作流程 ●工作流程图是针对具有工作流性质功能的规范化描述。 ●确定不同工作岗位协同工作的标准操作流程。 ●由于部分信息管理功能，需要多个岗位的协同工作才能完成，“工作流程”确定 了这些功能的操作步骤和规范。 ●工作流程使用MS Power Point绘制。 1.4.功能模块 “功能模块”即构成本系统的所有Notes应用数据库，设计文档以模块清单方式对所有功能模块进行定义，并以信息流图方式对模块之间的数据流动进行描述。
模块清单 描述说明 信息流图 ●主要用于描述各个Notes应用数据库之间信息的流动方向、方式 ●用户对应的工作岗位在信息流动中所起作用（如：启动、终止信息的流动，控制 流动方向）。 1.5.模块：模块名称 所有内容都以树型目录格式描述模块功能结构。每个目录节点对应一个操作对象或信息对象，包括下列内容： ●标题 格式：“对象类型：对象标题” 对象类型包括：导航器热点、视图、表单、操作等 ●权限 列出可以访问该对象的角色或用户 ●构成 以表格形式描述“视图”或“表单”对象的内容 ●说明 文字注释 简介 功能 描述该模块的主要功能 角色 定义可以访问该模块的所有“角色” 热点：热点名称 〖权限〗 指定可以执行此热点操作的用户。