《软件开发文档写作》课程标准

1、南京城市职业学院软件开发文档写作课程标准适用专业软件技术修学学期第3学期制订时间2014年9月课程代码322229课程学时48课程学分3课程类型B类课程性质选修课课程类别专业课对应职业资格证或内容无合作开发企业无执笔人孙旸合作者无审核人一、课程定位软件开发文档写作是软件技术专业的一门专业选修课程。它的先导课程为程序设计方法（Java）及实训、数据库应用基础及实训，后续课程为中期实训、软件开发过程与方法及实训、终期实训。软件开发文档写作是理论与实践相结合的职业能力类课程，这门课程是在学生掌握了基本的软件开发和数据库设计的基础上，有了一定的软件设计开发能力后，通过课堂基本知识的学习和实际项目实战相

2、结合的方式，使学生在以后的工作岗位中能够知道应用软件工程的方法来开发并撰写各类软件文档，力求达到培养的学生理论够用、技术过硬。二、课程设计思路 本课程从软件技术专业的角度出发，以软件生命周期中不同阶段的重要软件文档的写作为主线，通过对软件开发过程中不同软件开发文档写作方法的学习，培养学生软件工程化开发的意识和软件开发文档的写作能力，同时也为后续项目实战等课程提供更好的管理基础。学生通过课堂基本知识的学习和实际项目实战相结合的方式，在真实项目中学习并掌握软件开发文档的阅读和写作技能与方法，培养学生的综合职业能力、良好的职业素养。本课程的创新点在于结合了实际项目案例，让学生了解软件生命周期各阶段所

3、需要的各种文档的编写要求和注意事项。三、课程学习目标本课程以培养能合理编制和使用软件技术文档的软件开发人员为总目标。通过本课程的学习，了解国家有关计算机软件开发文档编制的标准和规范，让学生了解在软件生命周期全过程，了解软件生命周期各阶段所需要的各种文档，让学生从基于结构化方法和面向对象方法两方面，掌握可行性研究报告、软件需求规格说明书、概要设计说明书、详细设计说明书等几个重要文档的编写要求与编写方法，并掌握一些常用辅助软件的使用方法，进而培养学生的综合职业能力、良好的职业素养。知识目标了解软件文档的意义、作用、分类。了解软件工程的基本概念。系统掌握软件生命周期各阶段的目标、任务、特点、步骤和文

4、档。熟悉国家计算机软件文档编制规范能力目标能够根据软件的生存周期，描述期各阶段所需要的文档能够运用软件工程标准，在软件开发过程中，遵守相关标准能够根据可行性研究报告、软件需求规格说明书、概要设计说明书和详细设计说明书的编写要求，写出具体项目的需求规格说明书、概要设计说明书和详细设计说明书素质目标通过调查和搜集资料，提高信息采集、整理能力。通过撰写项目文档，提高书面表达能力。培养学生软件工程标准化的思想培养学生树立软件著作权的法律意识四、课程典型工作任务五、课程整体设计软件开发文档写作课程整体设计序号学习单元名称学习性工作任务学时分配1认识软件工程和Visio1) 软件工程基础知识2) Visi

5、o基本操作介绍3) 使用Visio绘制流程图4) 使用Visio绘制用例图42认识UML和Rose1) UML基础知识2) Rose操作练习3) 使用Rose绘制用例图4) 使用Rose绘制类图43数据库项目实践指南1) 数据库基本知识2) 数据库设计的基本步骤3) 实体关系图4) 构造E-R模型5) 数据库设计方法和技巧44项目立项阶段文档典型案例分析及实训1) 人事管理系统项目可行性研究报告案例分析2) 网络工资管理系统软件开发计划案例分析3) 网络论坛系统软件开发计划案例分析4) 实训一：项目建议书8序号学习单元名称学习性工作任务学时分配5需求分析书典型案例分析及实训1) 人事管理系统项

6、目需求规格说明书案例分析2) 网络工资管理系统需求规格说明书案例分析3) 网络论坛系统需求规格说明书案例分析4) 实训二：需求分析书86概要设计书典型案例分析及实训1) 人事管理系统项目概要设计书案例分析2) 网络论坛系统概要设计书案例分析3) 实训三：概要设计书87详细设计书典型案例分析及实训1) 人事管理系统项目详细设计书案例分析2) 网络论坛系统详细设计书案例分析3) 实训四：详细设计书88项目测试阶段文档典型案例分析及实训1) 计算机报价管理系统软件测试报告案例分析2) 实训五：测试用例4课程学习总学时48六、课程学习单元内容与要求学习单元名称认识软件工程和Visio学习性工作任务1.

7、目标：掌握软件工程基础知识和软件文档基础知识，掌握Visio的基本使用方法2.具体任务：软件工程的产生、软件生产发展史、软件生存周期、生存周期模型、软件文档的意义、软件文档的作用、软件文档的分类、Visio的使用方法3.活动设计：课堂学习、课堂讨论、课堂练习载体或活动课堂学习、课堂讨论、课堂练习学习方法建议讲授演示法、分组讨论法、练习法学习重点与难点重点：软件生存周期的基本概念、几种生存周期模型的特点、软件文档的分类、软件文档和使用者的关系、Visio的使用方法难点：软件文档和软件生存周期的关系组织实施建议1向学生讲述软件工程基础知识；2. 向学生讲述软件文档基础知识，并举例说明；3.学生进行

8、课堂讨论；4.介绍Visio的使用方法；5.学生使用Visio绘制流程图和用例图；6.布置预习或复习任务。学习场地与设施建议计算机机房、投影仪、教学广播软件、Microsoft Office套件、Microsoft Visio知识与技能准备无学习素材准备多媒体课件学习考核与评价从学习态度与交流考核学生上课的认真程度。学习单元设计拟实现的能力目标必须掌握的知识内容学时软件工程基础知识Z1.1掌握软件生存周期Z1.2掌握生存周期模型Z1.3掌握软件文档的作用Z1.4 掌握软件文档的分类等相关知识Z1.5 掌握软件文档和使用者的关系2Visio基本操作N2.1 能够使用Visio绘制流程图N2.2

9、能够使用Visio绘制用例图掌握Visio的基本使用方法2本学习单元学时小计4学习单元名称认识UML和Rose学习性工作任务1.目标：掌握UML基础知识，掌握Rose的基本使用方法2.具体任务：UML基本概念、用例图和类图的画法、Rose的使用方法3.活动设计：课堂学习、课堂练习载体或活动课堂学习、课堂练习学习方法建议讲授演示法、练习法学习重点与难点重点：UML基础知识和Rose的使用方法难点：使用Rose绘制用例图和类图的方法组织实施建议1.向学生讲述UML基础知识；2.介绍Rose的使用方法，介绍用例图和类图的画法；3.学生使用Rose绘制用例图和类图；4.布置预习或复习任务。学习场地与设

10、施建议计算机机房、投影仪、教学广播软件、Microsoft Office套件、Rational Rose知识与技能准备无学习素材准备多媒体课件学习考核与评价从学习态度与交流考核学生上课的认真程度。学习单元设计拟实现的能力目标必须掌握的知识内容学时UML基础知识Z1.1掌握UML基本概念Z1.2掌握用例图的画法Z1.3掌握类图的画法2Rose基本操作N2.1 能够使用Rose绘制用例图N2.2 能够使用Rose绘制类图掌握Rose的基本使用方法2本学习单元学时小计4学习单元名称数据库项目实践指南学习性工作任务1.目标：掌握数据库基础知识，掌握E-R图的画法2.具体任务：数据库基本知识、数据库设计

11、的基本步骤、实体关系图、构造E-R图、数据库设计方法和技巧3.活动设计：课堂学习、课堂练习载体或活动课堂学习、课堂练习学习方法建议讲授演示法、练习法学习重点与难点重点：数据库设计的基本步骤难点：数据库设计方法和技巧组织实施建议1.向学生讲述数据库基础知识；2.介绍数据库设计的基本步骤，介绍E-R图及其画法；3.学生绘制E-R图；4.介绍数据库的设计方法和技巧；5.布置预习或复习任务。学习场地与设施建议计算机机房、投影仪、教学广播软件、Microsoft Office套件、Microsoft Visio 、Rational Rose知识与技能准备无学习素材准备多媒体课件学习考核与评价从学习态度与

12、交流考核学生上课的认真程度。学习单元设计拟实现的能力目标必须掌握的知识内容学时数据库项目实践指南N1.1 能够绘制E-R图Z1.1掌握数据库基本概念Z1.2掌握数据库设计的基本步骤Z1.3掌握E-R图的画法Z1.4 掌握数据库设计方法和技巧4本学习单元学时小计4学习单元名称项目立项阶段文档典型案例分析及实训学习性工作任务1.目标：能够提供的资料撰写项目建议书2.具体任务：项目立项阶段文档的内容、要求、写作技巧和注意事项3.活动设计：课堂学习、课堂讨论、案例分析、课堂练习载体或活动案例：人事管理系统项目可行性研究报告、网络工资管理系统软件开发计划、网络论坛系统软件开发计划等实训一：项目建议书学习

13、方法建议讲授演示法、分组讨论法、案例分析法、练习法学习重点与难点重点：项目立项阶段文档的内容、要求难点：项目立项阶段文档的写作技巧和注意事项组织实施建议1指导学生通过对典型案例的分析，掌握项目立项阶段文档的内容、要求、写作技巧和注意事项的写作规范；2学生进行课堂讨论；3.现场练习撰写项目建议书；4.布置课后同步练习；5.布置预习或复习任务。学习场地与设施建议计算机机房、投影仪、教学广播软件、Microsoft Office套件、Microsoft Visio、Rational Rose知识与技能准备无学习素材准备多媒体课件学习考核与评价从学习态度与交流考核学生上课的认真程度。学习单元设计拟实现

14、的能力目标必须掌握的知识内容学时项目立项阶段文档典型案例分析及实训N1.1能够提供的资料撰写项目建议书Z1.1掌握项目立项阶段文档的内容、要求Z1.2掌握项目立项阶段文档的写作技巧和注意事项8本学习单元学时小计8学习单元名称需求分析书典型案例分析及实训学习性工作任务1.目标：能够提供的资料撰写需求分析书2.具体任务：需求分析书的内容、要求、写作技巧和注意事项3.活动设计：课堂学习、课堂讨论、案例分析、课堂练习载体或活动案例：人事管理系统需求规格说明书、网络工资管理系统需求规格说明书、网络论坛系统需求规格说明书实训二：需求分析书学习方法建议讲授演示法、分组讨论法、案例分析法、练习法学习重点与难点

15、重点：需求分析书的内容、要求难点：需求分析书的写作技巧和注意事项组织实施建议1指导学生通过对典型案例的分析，掌握需求分析书的内容、要求、写作技巧和注意事项的写作规范；2学生进行课堂讨论；3.现场练习撰写需求分析书；4.布置课后同步练习；5.布置预习或复习任务。学习场地与设施建议计算机机房、投影仪、教学广播软件、Microsoft Office套件、Microsoft Visio、Rational Rose知识与技能准备无学习素材准备多媒体课件学习考核与评价从学习态度与交流考核学生上课的认真程度。学习单元设计拟实现的能力目标必须掌握的知识内容学时需求分析书典型案例分析及实训N1.1能够提供的资料

16、撰写需求分析书Z1.1掌握需求分析书的内容、要求Z1.2掌握需求分析书的写作技巧和注意事项8本学习单元学时小计8学习单元名称概要设计书典型案例分析及实训学习性工作任务1.目标：能够提供的资料撰写概要设计书2.具体任务：概要设计书的内容、要求、写作技巧和注意事项3.活动设计：课堂学习、课堂讨论、案例分析、课堂练习载体或活动案例：人事管理系统概要设计书、网络论坛系统概要设计书实训三：概要设计书学习方法建议讲授演示法、分组讨论法、案例分析法、练习法学习重点与难点重点：概要设计书的内容、要求难点：概要设计书的写作技巧和注意事项组织实施建议1指导学生通过对典型案例的分析，掌握概要设计书的内容、要求、写作

17、技巧和注意事项的写作规范；2学生进行课堂讨论；3.现场练习撰写概要设计书；4.布置课后同步练习；5.布置预习或复习任务。学习场地与设施建议计算机机房、投影仪、教学广播软件、Microsoft Office套件、Microsoft Visio、Rational Rose知识与技能准备无学习素材准备多媒体课件学习考核与评价从学习态度与交流考核学生上课的认真程度。学习单元设计拟实现的能力目标必须掌握的知识内容学时概要设计书典型案例分析及实训N1.1能够提供的资料撰写概要设计书Z1.1掌握概要设计书的内容、要求Z1.2掌握概要设计书的写作技巧和注意事项8本学习单元学时小计8学习单元名称详细设计书典型案

18、例分析及实训学习性工作任务或项目1.目标：能够提供的资料撰写详细设计书2.具体任务：详细设计书的内容、要求、写作技巧和注意事项3.活动设计：课堂学习、课堂讨论、案例分析、课堂练习载体或活动案例：人事管理系统详细设计书、网络论坛系统详细设计书实训四：详细设计书学习方法建议讲授演示法、分组讨论法、案例分析法、练习法学习重点与难点重点：详细设计书的内容、要求难点：详细设计书的写作技巧和注意事项组织实施建议1指导学生通过对典型案例的分析，掌握详细设计书的内容、要求、写作技巧和注意事项的写作规范；2学生进行课堂讨论；3.现场练习撰写详细设计书；4.布置课后同步练习；5.布置预习或复习任务。学习场地与设施

19、建议计算机机房、投影仪、教学广播软件、Microsoft Office套件、Microsoft Visio、Rational Rose知识与技能准备无学习素材准备多媒体课件学习考核与评价从学习态度与交流考核学生上课的认真程度。学习单元设计拟实现的能力目标必须掌握的知识内容学时详细设计书典型案例分析及实训N1.1能够提供的资料撰写详细设计书Z1.1 掌握详细设计书的内容、要求Z1.2掌握详细设计书的写作技巧和注意事项8本学习单元学时小计8学习单元名称项目测试阶段文档典型案例分析及实训学习性工作任务或项目1.目标：能够提供的资料撰写测试用例2.具体任务：项目测试阶段文档的内容、要求、写作技巧和注意

20、事项3.活动设计：课堂学习、课堂讨论、案例分析、课堂练习载体或活动案例：计算机报价管理系统软件测试报告实训五：测试用例学习方法建议讲授演示法、分组讨论法、案例分析法、练习法学习重点与难点重点：项目测试阶段文档的内容、要求难点：项目测试阶段文档的写作技巧和注意事项组织实施建议1指导学生通过对典型案例的分析，掌握项目测试阶段文档的内容、要求、写作技巧和注意事项的写作规范；2学生进行课堂讨论；3.现场练习撰写测试用例；4.布置课后同步练习；5.布置预习或复习任务。学习场地与设施建议计算机机房、投影仪、教学广播软件、Microsoft Office套件、Microsoft Visio、Rational