IT专业文档写作-张华.doc

《软件文档写作教程》说课内容

目录

TOC\o1-3\h\z\u《软件文档写作教程》说课内容 1

一、课程目标 1

二、课程性质与任务 1

三、说课内容及各主要教学环节 1

第1章软件文档概论（理论：1学时） 1

第2章软件文档的写作规范（理论：2学时） 1

第3章软件项目立项阶段文档写作案例分析（2学时） 2

第4章需求分析书案例分析（2学时） 2

第5章需求分析书案例分析二（1学时） 3

第7章概要设计书案例分析一（1学时） 3

第8章概要设计书案例分析二（1学时） 4

第10章详细设计书案例分析（2学时） 4

第12章软件项目结束阶段文档（2学时） 5

一、课程目标

软件文档是整个软件开发工作的基础，软件生命周期始于软件文档，且密不分的一部分，软件文档贯穿着整个软件生命周期。与软件相关的专业，或者研究人员，对软件文档写作要求都十分重要。软件文档写作是一门实践性要求非常强的课程，结合软件开发实例培养学生实际软件文档写作能力，以及结合专业技术人员的基本方法与技巧，提高学生学生对软件文档写作的综合应用能力和解决实际问题的能力。

二、课程性质与任务

本课程将主要介绍软件文档写作的基本知识和基本方法。通过课程内容的贯彻，学习软件文档写作的理论知识和技术，掌握软件文档写作的基本概念和基本理论，掌握基本软件文档写作的规范和方法并通过案例了解实践应用，并能按照所介绍的方法自行分析和编写软件文档。

三、说课内容及各主要教学环节

第1章软件文档概论（理论：1学时）

教学内容有以下几点：

软件文档的意义

软件文档的作用

软件文档的分类

软件文档必备的条件

软件文档的管理

教学重点：文档分类

软件研发过程中各个阶段的文档分类：可行性研究报告；项目建议书；招投标文件；需求分析书；概要设计书；详细设计书；项目验收总结报告。

第2章软件文档的写作规范（理论：2学时）

1、教学内容有以下几点：

项目立项阶段文档的写作规范

需求分析书的写作规范

概要设计书的写作规范

详细设计书的写作规范

项目结束阶段文档的写作规范

2、教学重难点：

掌握每一个模块的规范要求；

重点：需求分析书的写作规范要求；概要设计书的写作规范要求

二者区分：

需求分析书：主要从用户角度出发，充分掌握用户的需求情况。

概要设计书：在需求分析书基础之上，将用户需求进行模块划分成具体可进行软件开发的内容。

第3章软件项目立项阶段文档写作案例分析（2学时）

本章内容开始逐项展开学习。以某市轨道交通突发事件实时应急集成指挥系统为例的一个比较完整的项目立项案例。

1、该案例主要从以下几方面展开学习：

项目的目的和意义

国内外研究开发现状和发展趋势

项目现有工作基础

项目实施目标

主要研究开发内容

社会经济效益分析和风险分析

年度目标和年度实施计划

预期主要成果

2、教学要求

通过学习掌握项目主要目的的抓取并能够准确定义研发内容；能够理解现有工作、实施目标的编写方法；了解现状、效益、风险、实施计划等的控制。

实例引用：重庆市轨道交通，在重庆乘坐轨道交通就是大家的日常，对每一个环节都基本亲身体验过，能把抽象化为实体，学生更容易理解与掌握课程内容。

第4章需求分析书案例分析（2学时）

本章内容是以研究生教务管理系统案例分析为例进行学习的。

1、该案例主要从以下几方面展开学习：

任务导论

任务概述

需求规定

运行环境规定

2、教学要求

掌握研发项目的需求的获取、挖掘和成文；掌握如何根据不同情况确定软件的环境。

3、教学重点

需求规定分：

需求规定分：

用例图——以图表形式；

用例规约——以表格形式详细列出各用约定。

对性能的规定：比如，精度，时间特性要求，数据管理能力要求等。

实例引用：重庆移通学院官网系统，学生都是实际使用者，能把抽象化为实体，学生更容易理解与掌握课程内容。

第5章需求分析书案例分析二（1学时）

本章案例是在第4章基础之上，对需求分析书进一步深入理解与学习的案例。课程以奥运综合服务系统案例分析为例展开学习的。

1、教学内容：

系统概述

功能与非功能需求

数据需求

接口需求

环境需求

2、教学要求

掌握研发项目的需求的获取、挖掘和成文；掌握如何根据不同情况确定软件的环境。

3、教学重点：

功能与非功能需求分：

功能模块划分：