软件文档写作01 概述.ppt

2020/4/3 软件文档写作实训 任课老师：冯茂岩 信息工程学院 2020/4/3 2 参考资料 ? 参考资料 《软件编档导论》 清华大学出版社 金波编著 《软件文档写作教程》 电子工业出版社 马平等编著 计算机软件工程标准 ( 文档部分 GB/T8567-1988 、 GB/T9385-1988) 国家标准汇编 中国标准出版社 2020/4/3 3 课程学时分配和评分标准 课时分配： 30 学时 考核标准：出勤（ 20% ） + 平时成绩（ 30%) + 综合报告 (50%) ＝总评（ 100% ） 2020/4/3 4 ? 了解软件文档在软件开发过程中的作用、地位 以及文档编制的有关标准； ? 理解软件文档与软件生存周期的关系，掌握软 件文档的分类； ? 熟悉软件文档的编写方法，了解常用的文档编 制工具软件； ? 能够根据标准模板编写可行性研究报告、需求 分析说明书、概要设计文档、详细设计文档、 用户文档和管理文档等； ? 熟悉毕业论文的撰写和编排。 教学目标 2020/4/3 软件文档写作课程实践要求 实践项目 ： 若干模拟题目 要 求 ： 每组不超过 6 人，设组长一名 组长负责 ： 组织、分工、安排进度等 组长奖罚 ： 引起过半数组员不满者，改选；带领全 组顺利完成任务者，总评 +5 目 的 ： 通过课程实践，实际体验软件工程各阶 段的主要工作；学会与他人合作，培养团队精神；培 养软件文档的写作能力，为毕业设计及论文的撰写打 下基础 5 2020/4/3 6 实 践 内 容 (1) 问题定义 （书面 、电子 ） （选做） (2) 可行性分析报告 （书面、 电子） （必做）朱 (3) 项目开发计划 （书面 、电子 ） （必做）韩 (4) 需求规格说明书 （书面 、电子 ） （必做）曹晓雯 (5) 总体设计报告 （书面 、电子 ） （必做）谢 (6) 系统测试计划 （书面 、电子 ） （选做） (7) 用户操作手册 （书面 、电子 ） （必做）高帅 (8) 模拟毕业论文 （书面 、电子 ） （必做）李 要求 ：根据软件工程技术和项目管理理念，在组内合 理分工，协同工作。 2020/4/3 7 问 : 什么是软件 ? 软件 = 程序 + 文档 2020/4/3 8 第一讲 软件文档概念 2020/4/3 9 1.1 为什么需要软件文档？ 文档是计算机软件产品的重要组成部分，没有文档就不成其 为软件，也更不能成为软件产品。 软件文档是一种重要的软件工程技术资料。如系统分析文档、 设计文档、版本说明文档…… 软件文档的规范编制，在软件开发工作中占有突出的地位和 相当大的工作量。高质量、高效率的编制、分发、管理、维护文 档，及时的变更、修正、扩充和使用文档，对于软件产品的设计 开发、发行使用、变更维护、转让移植、二次开发等，对于充分 发挥软件产品的效益，都有着重要的意义。 2020/4/3 10 1.2 软件文档的定义 软件文档写作是为了记录目标系统的定义、规划、分析、研究、设 计、开发、应用等各个阶段的设计思想和研究成果。 文档 —— 某种数据媒体和其中所记录的数据。 文档具有永久性，并可供人或机器阅读，通常指专供人阅读的东西。 文档作为计算机软件的重要组成部分，告诉用户如何操作和维护系 统，提供关于未来改进和重新实施所需的信息，在开发人员、维护人员、 管理人员、用户与计算机之间起着重要的桥梁作用。 维护人员 管理人员 计算机软件 用 户 桥梁作用 开发人员 2020/4/3 11 1.3 文档的作用 软件文档在产品开发过程中具有十分重要的桥梁作用，主要反映 在以下几个方面： ? 项目管理的依据 文档将通常“不可见的”软件开发进程转换成“可见的”文字资 料，有利于项目的管理。 ? 技术交流的语言 项目小组内部、项目平行开发的各小组之间进行的交流和联系， 通常都是通过文档来实现的。 ? 项目质量保证 文档是进行项目质量审查和评价的重要依据，有效文档的提供， 可以满足项目质量保证人员和审查人员的工作需要。 2020/4/3 12 ? 支持培训与维护 合格的软件文档通常都提供有关软件运行、维护和培训的必要信 息，支持软件产品的应用。 ? 支持软件维护 软件文档提供系统开发的全部必要技术资料，有利于维护人员熟 悉系统，开展维护工作；软件维护文档记载了软件维护过程中软件及 其环境变化的全部信息。 ? 记载软件历史 软件文档作为“记载软件历史的语言”，可用作未来项目的一种 资源，向潜在用户报道软件的各种有利信息，便于他们判断自己是否 需要该软件提供的服务。 良好的系统文档，显然有助于完成软件的移植，或将软件转移到 各种新的系统环境中去。 2020/4/3 13 1.4 软件文档的分类 国家标准局在 1988 年 1