重庆邮电大学软件工程学院
首页>> 本科生教育>> 课程设置>> 正文>>

《技术文档写作与沟通》课程教学大纲

一、课程基本情况

课程编号

130286/130287

课程类别

□必修 ■限选 □任选

学时/学分

32/2

课程名称

(中文)技术文档写作与沟通

(英文)Technology Documentation and Communication

教学方式

■课堂讲授为主 □实验为主 □自学为主 □专题讨论为主

课程学时

及其分配

课内总学时

课内学时分配

课外学时分配

32

课堂讲课

24

课后复习

24

自学交流

课外自学

24

课堂讨论

8

讨论准备

试验辅导

实验预习

课内试验

课外实验

4

考核方式

■闭卷 □开卷 □口试 □实际操作 □大型作业

成绩评定

期末考试(70%)+平时成绩(30%)

适用院系

适用专业

软件工程学院

软件工程、英语+软件、日语+软件

先修课程

预备知识

软件工程

二.课程性质与任务

《技术文档写作与沟通》课程是学科基础课程。其目的是通过本门课程的学习,使学生了解软件文档在软件开发过程中的作用、地位以及文档编制的有关标准,熟悉软件文档的编写方法,了解常用的文档编制工具软件,最终达到能够根据项目要求编写软件文档的能力,为学生掌握工程化的软件开发奠定基础。

三.课程主要教学内容及学时分配

序号

教学内容

学时

1

软件工程标准化与软件文档

4

2

软件文档及其组成

4

3

软件文档国家标准

2

4

软件文档写作要求

4

5

软件开发文档

6

6

软件管理文档

4

7

软件用户文档

4

8

软件文档管理

4

合计学时

32

四.课程教学基本内容和基本要求

通过本课程的学习,使学生理解软件文档在工程化的软件开发过程中的作用和意义;了解现有软件文档的标准体系;理解软件文档与软件生存周期的关系,掌握软件文档的分类;掌握软件文档编写的原则和步骤,能够根据标准模板编写简单需求分析说明书、概要设计文档、详细设计文档、用户文档和管理文档等。

第1章 软件工程标准化与软件文档

主要内容:软件工程标准的类型和软件工程标准化的意义;软件工程标准的分类,标准的层次,我国软件工程标准层次,ISO9000-3.

第2章 软件文档及其组成

主要内容:软件文档的概念、作用、分类,软件文档与软件生存周期的关系。

第3章 软件文档国家标准

主要内容:软件文档国家标准体系,计算机软件产品开发文档编制指南、计算机软件需求说明编制指南、计算机软件测试文档编制指南;软件需求文档的基本编写要求与方法;软件测试文档的基本编写要求与方法。

第4章 软件文档写作要求

主要内容:软件文档编写的原则、编写步骤和编写策略,如何建立文档的企业标准,文档的编制规程,文档的质量要求,文档编写技巧。

第5章 软件开发文档

主要内容:可行性研究报告编制的内容、编制要求和描述方法;需求文档的特点、内容和编写要求,软件需求文档的表达方法;概要设计说明书的编写方法、详细设计说明书的编制内容、编制特点和编制方法。

第6章 软件管理文档

主要内容:项目开发计划的内容和编写;掌握编写项目计划的常用表达方法,如里程碑、工作分解结构等;风险管理、软件测试计划、开发进度报告的编制内容。

第7章 软件用户文档

主要内容:用户文档的类型;用户文档编制的基本要求;用户手册、操作手册的编写。

第8章 软件文档管理

主要内容:文档管理的过程及管理方式;文档维护的几种形式;动态文档管理的含义;常见的项目管理软件的作用和功能。

五.课程内容的重点和深广度要求

1.掌握基本内容,这是本课程的基本出发点;

2.以培养学生的工程化思想为主线;

3.以具体的实例给学生讲清楚软件文档在软件开发过程的重要地位和作用,培养学生学习本课程的兴趣;

六.课后作业与课外辅导的要求

根据本课程的特点,要求学生根据项目开发要求编制三个标准的文档。

作业1:根据要求编写需求说明书;

作业2:根据要求编写概要设计说明书;

作业3:根据要求编写某个模块的详细设计说明书。

七.教材及主要参考书

教材:实用软件文档写作 清华大学出版社 肖刚等编著

主要参考书:

(1)软件文档写作教程 电子工业出版社 马平,黄冬梅编著

(2)Software Documentation for Professionals Sharanam Shah,AartiShah/Arizona BusinessAlliance

八.学习方法与建议

本课程主要涉及到众多的标准,有可能显得枯燥。针对这种情况,教师应结合实际的项目或软件开发的经验加以讲述,多举一些案例,以形象的方式表达和处理课程的内容,也可以组织一些有针对性的题目进行讨论,使学生参与进来,增加互动,在这个过程中注意培养学生以工程的思想开发软件的重要性。