《软件文档写作》教学大纲

2022-07-28 00:44:14   第一文档网     [ 字体: ] [ 阅读: ] [ 文档下载 ]
说明:文章内容仅供预览,部分内容可能不全。下载后的文档,内容与下面显示的完全一致。下载之前请确认下面内容是否您想要的,是否完整无缺。下载word有问题请添加QQ:admin处理,感谢您的支持与谅解。点击这里给我发消息

#第一文档网# 导语】以下是®第一文档网的小编为您整理的《《软件文档写作》教学大纲》,欢迎阅读!
教学大纲,写作,文档,软件

《软件文档写作》教学大纲

课程编号:sa069162

英文名称:Software Document Writing 课程类型:实践教学 课程要求:必修 学时/学分1/1

适用专业:软件工程



一、课程设计性质与任务

《软件文档写作》是软件工程专业的一门专业实践课。软件文档写作是软件开发过程中的重要工作,符合软件工程质量标准的、规范化的文档在软件生命周期中起着表达思想、递信息的重要作用,是保证软件开发质量、提高软件可维护性、可靠性和可生产性的重要保障。课程主要讲授软件文档的工程标准、软件项目文档的基本结构、阅读方式及软件项目文档编写的基本要求和方法,对培养学生遵守工程规范,提高学生文档撰写能力有重要作用。

本课程的任务是使学生掌握软件文档写作的基本知识和基本技能,能够合理选择使用常用的文档撰写CASE工具,能够独立地进行基本的软件文档编写并在软件文档写作过程中自觉遵守工程规范。

二、 课程设计与其他课程或教学环节的联系

先修课程包括软件工程、用户需求与系统建模、文献检索与科技文档写作、软件项目组织与管理。

后续课程包括项目实践类课程、毕业设计等。

先修课程为学生理解本课程中涉及到的概念、各阶段文档特点、文献检索和写作方法提供理论和技术支撑。本课程为后续专业课程实验报告撰写、论文及软件工程项目各阶段文档阅读和撰写做好知识和技能准备。

三、课程设计教学目标

1. 本课程通过软件文档作用、标准等知识学习,使学生具有人文社会科学素养、社会责任感,能够在软件工程实践中理解并遵守工程职业道德和规范,遵守和履行相关法律责任。(支撑毕业要求8)

2. 能够在多学科背景下的团队中,按照软件文档的适用范围承担个体、团队成员以及负责人的角色。(支撑毕业要求9)

3. 通过学习,使学生掌握软件文档写作的基本知识和基本技能,能够结合软件企业软件文档编写技术要求独立地进行基本的软件文档编写。并具备一定的国际视野,能够理解和撰写符合国际标准的软件文档。(支撑毕业要求10)




四、教学内容、基本要求与学时分配



教学内容



教学要求



教学 方式

对应课程教学目标

1 一、软件文档的作用

1.软件文档作用及分类 2.软件工程标准的制定与推行 3.我国的软件工程标准化工作 4.计算机软件产品开发文件编制指南

1.认识软件文档在软件工程中的作用,能够在不同应用范围选择使用不同类型的软件文档;

2.学习软件工程标准的制定与推行过程;

3.学习我国的软件工程标准化工作;

4.能够查找和使用计算机软件产品开发文件编制指南的查找和使用方法。

1 讲授 12

2 二、常用软件文档

1.可行性研究报告 2.软件需求说明书 3.概要设计说明书 4.详细设计说明书 3

三、软件文档撰写常用工具 1.常用CASE工具 2. EndNote安装使用

1.能够参文档标准撰写可行性研究报告;

2.能够参文档标准撰写软件需求说明书;

3.能够参文档标准撰写概要和详细设计说明书

1.掌握CASE工具支持下的文档写作方法;

2.掌握EndNote安装配置方案,能够在文档写作过程中使用EndNote搜索和编辑参考文献。

2 讲授 12

1 实验 3

4 四、撰写《软件项目计划》并验

能够参考软件项目管理及开发文档写作规范撰写《软件项目计划》

1 实验 123




五、考核及成绩评定

参考课程设计任务书,任意选取一个软件项目,以撰写“软件项目计划”报告。要求符合任务书中的撰写规范要求。

最终成绩由实验成绩、软件项目计划撰写质量、答辩成绩和报告成绩等组合而成。各部分所占比例如下:

实验成绩:30%。主要考核实验完成情况,文档的规范性。

软件项目计划撰写质量:30%。主要考核项目计划的合理性,表述准确性。 答辩成绩:20%。主要考核能否正确描述设计原理及所解决问题,正确回答答辩问题。

报告成绩:20%。主要考核报告撰写是否规范正确,内容是否齐全,书写工整。 八、课程设计参考资料

[1] 肖刚. 软件文档. 清华大学出版社, 2012. [2] 潘孝铭. 软件文档编写. 高等教育出版社, 2009.

[3] 计算机软件产品开发文件编制指南GB856688, 中国标准出版社, 2010.


本文来源:https://www.dywdw.cn/b723dd1cf48a6529647d27284b73f242336c31a1.html

相关推荐
推荐阅读