文档与的作用与分类及各种文档编写摸板.docVIP

文档的作用与分类 1. 文档的概念 文档（document）是指某些数据媒体和其中所记录的数据。文档具有永久性，并可以由人或机器阅读。 在软件工程中文档常常用来表示对活动、需求、过程或结果进行描述、定义、规定、报告或认证的任何书面或图示的信息。它们描述和规定了软件设计和实现的细节，说明使用软件的操作命令。文档也是软件产品的一部分，没有文档的软件就不成其为软件。软件文档的编制在软件开发中占有突出的地位和相当大的工作量。高质量，高效率地开发、管理和维护文档对于转让、变更、修正、扩充和使用文档，对于充分发挥软件产品的效益有着重要的意义。 在写文档之前必须考虑：1、应当写哪些内容2、说明什么问题3、起什么作用？ 2．文档的作用 在软件的开发与生产过程中，总是伴随着大量的信息要记录，要使用，因此，软件文档在产品的开发生产过程中起着重要的作用。 提高软件开发过程中的能见度 即把开发过程中发生的事件以某种可阅读的形式记录在文档中，这些记录可作为检查软件开发进度和开发质量的依据，实现对软件开发的工程管理。 提高开发效率 文档的编制，使开发人员对各个阶段的工作都进行周密的思考，全盘权衡，从而减少返工，并可在开发早期发现错误和不一致性，便于及时加以纠正。 记录开发过程中的有关信息，便于协调以后（后面）的软件，开发、使用和维护。 作为开发人员在一定阶段的工作成果和结束标志，（即告一段落的标志） 文档可提供对软件的运行，维护和培训有关信息，便于管理人员，开发人员，操作人员和用户之间的协作，交流与了解，使软件开发活动更科学，更有成效。 提供市场效益。 文档便于潜在用户了解软件的功能，性能等各项指标，为他们选购符合自己需要的软件提供必要依据。 3.文档的分类 按照文档产生和使用的范围大致可分为三类： 开发文档 这类文档内容包括： 1.可行性研究报告 2.项目开发计划 3.软件需求说明书 4.数据要求说明书 5.概要设计说明书 6.详细设计说明书 管理文档 这类文档内容包括： 1.开发计划 2.测试计划 3.测试报告 4.开发进度月报 5.项目开发总结 3) 用户文档 这类文档是软件开发人员为用户准备的有关软件使用、操作、和维护的资料。主要包括用户手册、操作手册、维护修改建议和软件需求说明书。 软件项目开发过程文档编写指南 开发一个项目需要考虑以下文档的编写，这些文档包括： 可行性研究报告 项目开发计划 需求规格说明书（软件需求说明书） 概要设计说明书 详细设计说明书 用户操作手册 测试计划 测试报告 开发进度月报 10．项目开发总结报告 11．程序维护手册 12．软件问题报告 13．软件修改报告 撰写各种文档的参考提纲 为了使同学们具体了解怎样编写文档，下面列出了十几种文档的内容、要求及简单说明，并给出了一个统一的文档封面格式供大家参考。 文档封面格式如下： 文档编号 _______ 版 本 号 _______ 文档名称：________ 项目名称：________ 项目负责人：________ 编写________ _____年_____月_____日 校对________ _____年_____月_____日 审核________ _____年_____月_____日 批准________ _____年_____月_____日 开发单位________ 可行性研究报告 1. 引言 1．1编写目的【阐明编写可行性研究报告的目的，指出读者对象。】 1．2项目背景【应包括：a．所建议开发软件的名称；b．项目任务提出者、开发者、用户及实现软件的单位；c．项目与其他软件或其他系统的关系。】 1．3定义【列出文档中用到的专门术语的定义和缩写词的原文。】 1．4参考资料【列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：a.项目经核准的计划任务书、合同或上级机关的批文；b.与项目有关的已发表的资料；c.文档中所引用的资料，所采用的软件标准或规范。】 2．可行性研究的前提 2．1要求【列出并说明建议开发软件的基本要求，如：a．功能；b．性能；c．输出；d．输入；e．基本的数据流程或处理流程；f．安全与保密要求；g．与软件有关的其他系统；h．完成期限。】 2．2设计目标【可包括：a．人力与设备费用的节省；b．处理速度的提高；c．控制精度和生产能力的提高；d．管理信息服务的改进；e．决策系统的改进；f．人员工作效率的提高，等等。】 2．3 条件、假定和限制【可包括：a．建议软件开发运