1 文档的作用与分类 1. 文档的概念 文档（docu ment）是指某些数据媒体和其中所记录的数据。文档具有永久性，并可以由人或机器阅读。 在软件工程中文档常常用来表示对活动、需求、过程或结果进行描述、定义、规定、报告或认证的任何书面或图示的信息。它们描述和规定了软件设计和实现的细节，说明使用软件的操作命令。文档也是软件产品的一部分，没有文档的软件就不成其为软件。软件文档的编制在软件开发中占有突出的地位和相当大的工作量。高质量，高效率地开发、管理和维护文档对于转让、变更、修正、扩充和使用文档，对于充分发挥软件产品的效益有着重要的意义。 在写文档之前必须考虑：1、应当写哪些内容 2、说明什么问题 3、起什么作用？ 2．文档的作用 在软件的开发与生产过程中，总是伴随着大量的信息要记录，要使用，因此，软件文档在产品的开发生产过程中起着重要的作用。 （1） 提高软件开发过程中的能见度 即把开发过程中发生的事件以某种可阅读的形式记录在文档中，这些记录可作为检查软件开发进度和开发质量的依据，实现对软件开发的工程管理。 （2） 提高开发效率 文档的编制，使开发人员对各个阶段的工作都进行周密的思考，全盘权衡，从而减少返工，并可在开发早期发现错误和不一致性，便于及时加以纠正。 （3） 记录开发过程中的有关信息，便于协调以后（后面）的软件，开发、使用 2 和维护。 （4 ） 作为开发人员在一定阶段的工作成果和结束标志，（即告一段落的标志） （5 ） 文档可提供对软件的运行，维护和培训有关信息，便于管理人员，开发人员，操作人员和用户之间的协作，交流与了解，使软件开发活动更科学，更有成效。 （6 ） 提供市场效益。 文档便于潜在用户了解软件的功能，性能等各项指标，为他们选购符合自己需要的软件提供必要依据。 3 .文档的分类 按照文档产生和使用的范围大致可分为三类： 1 ） 开发文档 这类文档内容包括： 1 .可行性研究报告 2 .项目开发计划 3 .软件需求说明书 4 .数据要求说明书 5 .概要设计说明书 6 .详细设计说明书 2 ） 管理文档 这类文档内容包括： 1 .开发计划 2 .测试计划 3 3 .测试报告 4 .开发进度月报 5 .项目开发总结 3 ) 用户文档 这类文档是软件开发人员为用户准备的有关软件使用、操作、和维护的资料。主要包括用户手册、操作手册、维护修改建议和软件需求说明书。 软件项目开发过程文档编写指南 开发...
VIP
