《软件工程文档写作》ppt课件

《《软件工程文档写作》ppt课件》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、软件文档什么是文档文档(document)是指某种数据媒体和其中所记录的数据。它具有永久性，并可以由人或机器阅读，通常仅用于描述人工可读的东西。在软件工程中，文档常常用来表示对活动、需求、过程或结果进行描述、定义、规定、报告或认证的任何书面或图示的信息。软件文档的作用在软件生产过程中，软件文档在产品的开发过程中起着重要的作用：提高软件开发过程的能见度。把开发过程中发生的事件以某种可阅读的形式记录在文档中。管理人员可把这些记载下来的材料作为检查软件开发进度和开发质量的依据，实现对软件开发的工程管理。提高开发效率

2、。软件文档的编制，使得开发人员对各个阶段的工作都进行周密思考、全盘权衡、减少返工。并且可在开发早期发现错误和不一致性，便于及时加以纠正。作为开发人员在一定阶段的工作成果和结束标志。记录开发过程中有关信息，便于协调以后的软件开发、使用和维护。软件文档的作用提供对软件的运行、维护和培训的有关信息，便于管理人员、开发人员、操作人员、用户之间的协作、交流和了解。使软件开发活动更科学、更有成效。便于潜在用户了解软件的功能、性能等各项指标，为他们选购符合自己需要的软件提供依据。软件文档的作用文档的桥梁作用文档的分类软件文

3、档从形式上来看，大致可分为两类：一类是开发过程中填写的各种图表，称之为工作表格；一类是应编制的技术资料或技术管理资料，称之为文档或文件。按照文档产生和使用的范围，软件文档大致可分为三类：1、开发文档软件需求说明书数据要求说明书概要设计说明书详细设计说明书可行性研究报告项目开发计划文档的分类2、管理文档项目开发计划测试计划测试报告开发进度月报项目开发总结3、用户文档用户手册操作手册维护修改建议软件需求说明书文档的分类软件文档的工作国家标准局在1988年1月发布了《计算机软件开发规范》《软件产品开发文件编制指南》

4、作为软件开发人员工作的准则和规程。它们基于软件生存期方法，把软件产品从形成概念开始，经过开发、使用和不断增补修订，直到最后被淘汰的整个过程应提交的文档归于以下十三种。1、可行性研究报告说明该软件项目的实现在技术上、经济上和社会因素上的可行性;评述为合理地达到开发目标可供选择的各种可能的实现方案;说明并论证所选定实施方案的理由。文档的分类2、项目开发计划为软件项目实施方案制定出的具体计划。它包括各部分工作的负责人员开发的进度开发经费的概算所需的硬件和软件资源等项目开发计划应提供给管理部门，并作为开发阶段评审的基

5、础。文档的分类3、软件需求说明书对目标软件的功能、性能、用户界面及运行环境等作出详细的说明。它是用户与开发人员双方对软件需求取得共同理解基础上达成的协议，也是实施开发工作的基础。4、数据要求说明书给出数据逻辑描述和数据采集的各项要求,为生成和维护系统的数据文件做好准备。文档的分类5、概要设计说明书该说明书是概要设计工作阶段的成果。它应当说明系统的功能分配模块划分程序的总体结构输入输出及接口设计运行设计数据结构设计出错处理设计等为详细设计奠定基础。文档的分类6、详细设计说明书着重描述每一个模块是如何实现的，包括

6、实现算法、逻辑流程等。7、用户手册详细描述软件的功能、性能和用户界面，使用户了解如何使用该软件。8、操作手册为操作人员提供软件各种运行情况的有关知识，特别是操作方法细节。文档的分类9、测试计划针对组装测试和确认测试，需要为组织测试制定计划。计划应包括测试的内容进度安排条件人员测试用例的选取原则测试结果允许的偏差范围等文档的分类10、测试分析报告测试工作完成后，应提交测试计划执行情况的说明。对测试结果加以分析，并提出测试的结论性意见。11、开发进度月报该月报是软件人员按月向管理部门提交的项目进展情况的报告。报告

7、应包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的打算等。文档的分类12、项目开发总结报告软件项目开发完成之后，应当与项目实施计划对照，总结实际执行的情况，如进度、成果、资源利用、成本和投入的人力。还需对开发工作作出评价，总结经验和教训。文档的分类13、维护修改建议软件产品投入运行之后，可能有修正、更改等问题，应当对存在的问题、修改的考虑以及修改的影响估计等做详细的描述，写成维护修改建议，提交审批。以上软件文档是在软件生存期中，随着各个阶段工作的开展适时编制的。其中，有的仅反映某

8、一个阶段的工作，有的则需跨越多个阶段。文档的分类软件生存期各阶段与各种文档编制的关系文档最终要向软件管理部门，或向用户回答下列问题哪些需求要被满足（What）；软件在什么环境中实现，所需信息从哪里来（Where）；开发时间如何安排（When）；开发(或维护)工作打算由谁来做（Who）；需求应如何实现（How）；为什么要进行这些软件开发或维护修改工作（Why）。文档要回答的问题对文档编制的质量要求如果