《实用软件文档写作》教师参考.doc

HYPERLINK"http://www.wordwendang.com"http://www.wordwendang.com

更多相关文档免费下载请登录:HYPERLINK"http://www.wordwendang.com"http://www.wordwendang.com-中文word文档库

《实用软件文档写作》教师参考
软件文档是规范化软件生产的重要依据，它直接关系到软件开发过程的可见性及可控
本文档由【HYPERLINK"http://www.wordwendang.com"中文word文档库】HYPERLINK"http://www.wordwendang.com"www.wordwendang.com提供，转载分发敬请保留本信息；
HYPERLINK"http://www.wordwendang.com"中文word文档库免费提供海量范文、教育、学习、政策、报告和经济类word文档。
<ahref='http://www.wordwendang.com/'>word文档</a>

性，因此，软件文档编写在软件开发过程中具有重要的地位和作用。通过本课程的学习，将使学生树立标准化、工程化的思想，掌握软件文档编写的基本方法和技能。
一、课程内容
1、课程描述
课程名称：软件文档写作
课程英文译名：SoftwareDocumentation
课程类别：学科基础选修课
开课对象：计算机科学与技术、软件工程、其他相关专业
学时：建议最少为16学时。考虑到本课程与软件工程课程紧密相连，如果学生不具备软件工程有关知识，可以适当增加学时，补充相应的内容。
理论课学时：14学时；
实验学时：2学时；
先修课程：软件工程、数据库原理、程序设计
2、课程的性质、目的和任务
本课程的性质是学科基础选修课。其目的是通过本门课程的学习，使学生了解软件文档在软件开发过程中的作用、地位以及文档编制的有关标准，熟悉软件文档的编写方法，了解常用的文档编制工具软件，最终达到能够根据项目要求编写软件文档的能力，为学生掌握工程化的软件开发奠定基础。
3、课程的基本要求
通过本课程的学习，使学生理解软件文档在工程化的软件开发过程中的作用和意义；了解现有软件文档的标准体系；理解软件文档与软件生存周期的关系，掌握软件文档的分类；掌握软件文档编写的原则和步骤，能够根据标准模板编写简单需求分析说明书、概要设计文档、详细设计文档、用户文档和管理文档等。
二、教学内容及学时安排
1、理论教学
第1章软件工程标准化与软件文档（2学时）
主要内容：软件工程标准的类型和软件工程标准化的意义；软件工程标准的分类，标准的层次，我国软件工程标准层次，ISO9000-3。
第2章软件文档及其组成（1学时）
主要内容：软件文档的概念、作用、分类，软件文档与软件生存周期的关系。
第3章软件文档国家标准（2学时）
主要内容：软件文档国家标准体系，计算机软件产品开发文档编制指南、计算机软件需求说明编制指南、计算机软件测试文档编制指南；软件需求文档的基本编写要求与方法；软件测试文档的基本编写要求与方法。
第4章软件文档写作要求（2学时）
主要内容：软件文档编写的原则、编写步骤和编写策略，如何建立文档的企业标准，文档的编制规程，文档的质量要求，文档编写技巧。
第5章软件开发文档（3学时）
主要内容：可行性研究报告编制的内容、编制要求和描述方法；需求文档的特点、内容和编写要求，软件需求文档的表达方法；概要设计说明书的编写方法、详细设计说明书的编制内容、编制特点和编制方法。
第6章软件管理文档（2学时）
主要内容：项目开发计划的内容和编写；掌握编写项目计划的常用表达方法，如里程碑、工作分解结构等；风险管理、软件测试计划、开发进度报告的编制内容。
第7章软件用户文档（1学时）
主要内容：用户文档的类型；用户文档编制的基本要求；用户手册、操作手册的编写。
第8章软件文档管理（1学时）
主要内容：文档管理的过程及管理方式；文档维护的几种形式；动态文档管理的含义；常见的项目管理软件的作用和功能。
2、实验安排（2学时）
本实验要求学生掌握软件文档写作的常用软件工具，如MSVisio、MSProject等工具软件，学生根据要求通过这些软件完成标准文档的制作。
3、需要注意的问题
本课程主要涉及到众多的标准，有可能显得枯燥。针对这种情况，教师应结合实际的项目或软件开发的经验加以讲述，多举一些案例，以形象的方式表达和处理课程的内容，也可以组织一些有针对性的题目进行讨论，使学生参与进来，增加互动，在这个过程中注意培养学生以工程的思想开发软件的重要性。为此，建议教师做到以下几点：
（1）掌握基本内容，这是本课程的基本出发点；
（2）以培养学生的工程化思想为主线；
（3）以具体