软件工程文档写作概论.ppt

什么是文档 文档(document)是指某种数据媒体和其中所记录的数据。 它具有永久性，并可以由人或机器阅读，通常仅用于描述人工可读的东西。 在软件工程中，文档常常用来表示对活动、需求、过程或结果进行描述、定义、规定、报告或认证的任何书面或图示的信息。 软件文档的作用 在软件生产过程中，软件文档在产品的开发过程中起着重要的作用： 提高软件开发过程的能见度。把开发过程中发生的事件以某种可阅读的形式记录在文档中。 管理人员可把这些记载下来的材料作为检查软件开发进度和开发质量的依据，实现对软件开发的工程管理。 软件文档的作用 提高开发效率。软件文档的编制，使得开发人员对各个阶段的工作都进行周密思考、全盘权衡、减少返工。并且可在开发早期发现错误和不一致性，便于及时加以纠正。 作为开发人员在一定阶段的工作成果和结束标志。 记录开发过程中有关信息，便于协调以后的软件开发、使用和维护。 软件文档的作用 提供对软件的运行、维护和培训的有关信息，便于管理人员、开发人员、操作人员、用户之间的协作、交流和了解。使软件开发活动更科学、更有成效。 便于潜在用户了解软件的功能、性能等各项指标，为他们选购符合自己需要的软件提供依据。 文档的分类 软件文档从形式上来看，大致可分为两类： 一类是开发过程中填写的各种图表，称之为工作表格； 一类是应编制的技术资料或技术管理资料，称之为文档或文件。 文档的分类 按照文档产生和使用的范围，软件文档大致可分为三类： 1、开发文档 软件需求说明书 数据要求说明书 概要设计说明书 详细设计说明书 可行性研究报告 项目开发计划 文档的分类 2、管理文档 项目开发计划 测试计划 测试报告 开发进度月报 项目开发总结 3、用户文档 用户手册 操作手册 维护修改建议 软件需求说明书 软件文档的工作 国家标准局在1988年1月发布了 《计算机软件开发规范》 《软件产品开发文件编制指南》 作为软件开发人员工作的准则和规程。它们基于软件生存期方法，把软件产品从形成概念开始，经过开发、使用和不断增补修订，直到最后被淘汰的整个过程应提交的文档归于以下十三种。 文档的分类 1、可行性研究报告 说明该软件项目的实现在技术上、经济上和社会因素上的可行性; 评述为合理地达到开发目标可供选择的各种可能的实现方案; 说明并论证所选定实施方案的理由。 文档的分类 2、项目开发计划 为软件项目实施方案制定出的具体计划。它包括 各部分工作的负责人员 开发的进度 开发经费的概算 所需的硬件和软件资源等 项目开发计划应提供给管理部门，并作为开发阶段评审的基础。 文档的分类 3、软件需求说明书 对目标软件的功能、性能、用户界面及运行环境等作出详细的说明。 它是用户与开发人员双方对软件需求取得共同理解基础上达成的协议，也是实施开发工作的基础。 4、数据要求说明书 给出数据逻辑描述和数据采集的各项要求, 为生成和维护系统的数据文件做好准备。 文档的分类 5、概要设计说明书 该说明书是概要设计工作阶段的成果。它应当说明 系统的功能分配 模块划分 程序的总体结构 输入输出及接口设计 运行设计 数据结构设计 出错处理设计等 为详细设计奠定基础。 文档的分类 6、详细设计说明书 着重描述每一个模块是如何实现的，包括实现算法、逻辑流程等。 7、用户手册 详细描述软件的功能、性能和用户界面，使用户了解如何使用该软件。 8、操作手册 为操作人员提供软件各种运行情况的有关知识，特别是操作方法细节。 文档的分类 9、测试计划 针对组装测试和确认测试，需要为组织测试制定计划。计划应包括 测试的内容 进度安排 条件 人员 测试用例的选取原则 测试结果允许的偏差范围等 文档的分类 10、测试分析报告 测试工作完成后，应提交测试计划执行情况的说明。对测试结果加以分析，并提出测试的结论性意见。 11、开发进度月报 该月报是软件人员按月向管理部门提交的项目进展情况的报告。报告应包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的打算等。 文档的分类 12、项目开发总结报告 软件项目开发完成之后，应当与项目实施计划对照，总结实际执行的情况，如进度、成果、资源利用、成本和投入的人力。 还需对开发工作作出评价，总结经验和教训。 文档的分类 13、维护修改建议 软件产品投入运行之后，可能有修正、更改等问题，应当对存在的问题、修改的考虑以及修改的影响估计等做详细的描述，写成维护修改建议，提交审批。 以上软件文档是在软件生存期中，随着各个阶段工作的开展适时编制的。其中，有的仅反映某一个阶段的工作，有的则需跨越多个阶段。 软件生存期各阶