软件文档写作概述.pptVIP

软件文档写作Software Document Composition 课程目的 通过本门课程的学习，了解软件文档在软件开发过程中的作用、地位以及文档编制的有关标准，熟悉软件文档的编写方法； 了解各种文档编制规范，最终能够根据项目要求编写软件文档的能力，奠定工程化的软件开发基础。 课程内容和要求 通过本课程的学习，使学生理解软件文档在工程化的软件开发过程中的作用和意义； 了解现有软件文档的标准体系； 理解软件文档与软件生存周期的关系，掌握软件文档的分类； 掌握软件文档编写的原则和步骤，能够根据标准模板编写简单需求分析说明书、概要设计文档、详细设计文档、用户文档和管理文档等。 课程特点 (1)掌握基本内容——出发点； (2)培养学生的工程化思想； (3)以具体的实例，讲解软件文档在软件开发过程的重要地位和作用，培养学生学习兴趣； (4)以案例贯穿在授课内容之中，使用本附录中提供的案例；平时作业制定案例；课程设计分组指定案例； (5)注意互动，组织讨论，使学生主动参与到教学中来。 教学内容 1.软件文档概述（第1章） 2.软件工程标准化（第2章） 3.软件视图和文档风格（第3章相关） 4.软件文档表达（第4章） 5.软件编档的要求（第5章） 6.软件开发文档（第6章） 7.软件管理文档（第7章） 9.软件用户文档（第8章） 9.软件文档发行（第9章） 10.软件编档管理（第10章） 11.软件产品开发文档编制的国家标准及模版（附录A） 12.软件文档实例分析 书面作业 每一章的重点、难点 查阅资料总结 实践性环节作业 《可行性研究报告》 《项目开发计划》 《软件需求说明书》 《数据要求说明书》 《概要设计说明书》 《详细设计说明书》 《数据库设计说明书》 《用户手册》 《操作手册》 《模块开发卷宗》 《测试计划》 《测试分析报告》 《开发进度月报》 《开发总结报告》 软件文档写作课程设计项目 Home Design and Improvement System 课程设计项目是若干模拟情景题目 要求：每组6人，设组长一名； 组长负责：组织、分工、安排进度等； 目的：通过课程设计，实际体验软件工程各阶段的主要工作，特别注意吸取教训；学会与他人合作，培养团队精神。 1.1 为什么需要软件文档？（理解） 1.2 软件文档的定义（了解） 1.3 软件文档的作用（理解、重点） 1.4 软件文档的分类（掌握、重点） 1.5 软件文档与使用者的关系（掌握、重点） 1.6 软件文档编制与软件生存期的关系（理解、难点） 本章重点 1.3 软件文档的作用（理解、重点） 1. 项目管理的依据 2. 技术交流的语言 3. 项目质量保证 4. 支持培训与维护 5. 支持软件维护 6. 记载软件历史 1.4 软件文档的分类（掌握、重点） 开发文档、用户文档和管理文档 1.5 软件文档与使用者的关系（掌握、重点） 软件文档的使用对象：开发人员、维护人员、管理人员、用户 1.6 软件文档编制与软件生存期的关系（理解、难点） 本章作业 1.书面作业：软件文档作用、分类、软件文档与使用者的关系 2.操作作业：查阅软件文档编制与软件生命期的关系的资料 * * 教 材 ? 教材：软件编档导论 金波 编著 清华大学出版社 ? 参考资料： 实用软件文档写作 清华大学出版社 肖刚等编著 计算机软件工程标准(文档部分GB/T8567-1988、GB/T9385-1988) 国家标准汇编 中国标准出版社 课程学时分配和评分标准 课时分配：每周8节，共7周 平时成绩：书面作业占 25 % 实践性环节占 50 % 考勤占 25 % 考试方法：开卷（待定） 评分标准：课程设计(60%)＋平时成绩(40%) ＝总评 100%（待定） 工 作 内 容 ⑴《可行性研究报告》 ⑵《项目开发计划》 ⑶《软件需求说明书》 ⑷《数据要求说明书》 ⑸《概要设计说明书》 ⑹《详细设计说明书》 ⑺《数据库设计说明书》 ⑻《用户手册》 ⑼《操作手册》 ⑽《模块开发卷宗》 ⑾《测试计划》 ⑿《测试分析报告》 ⒀《开发进度月报》 ⒁《开发总结报告》 要求：根据软件工程技术和项目管理理念，在组内合理分工，协同工作。 第一章 软件文档概念 第一章 软件文档概念 1.1 为什么需要软件文档？ 文档是计算机软件产品的重要组成部分，