软件文档写作教程

封面

版权信息

前言

第1章 绪论

1.1 软件文档的意义

1.2 软件文档的作用

1.3 软件文档的分类

1.3.1 可行性研究报告

1.3.2 项目建议书

1.3.3 招投标文件

1.3.4 需求分析书

1.3.5 概要设计书

1.3.6 详细设计书

1.3.7 项目验收总结报告

1.4 软件文档必备的条件

1.4.1 完整性

1.4.2 准确性

1.4.3 易用性

1.4.4 及时性

1.5 软件文档的管理

1.5.1 管理者的作用

1.5.2 制订文档编制策略

1.5.3 制订文档编制标准和指南

1.5.4 文档编制计划

本章小结

参考文献

第2章 软件文档的写作规范

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

2.1.1 可行性研究报告

2.1.2 项目建议书

2.1.3 招投标文件

2.2 需求分析书的写作规范

2.2.1 需求分析书的编制目标

2.2.2 需求分析书的基本要求

2.2.3 需求分析书的适用范围

2.2.4 需求分析书的编写

2.3 概要设计书的写作规范

2.3.1 概要设计书的编制目标

2.3.2 概要设计书的基本要求

2.3.3 概要设计书的内容

2.3.4 概要设计书的编写

2.4 详细设计书的写作规范

2.4.1 详细设计书的编制目标

2.4.2 详细设计书的基本要求

2.4.3 详细设计书的内容

2.4.4 详细设计书的编写

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

2.5.1 项目验收报告

2.5.2 项目总结报告

本章小结

参考文献

习题

第3章 软件项目立项阶段文档写作案例分析

3.1 项目的目的和意义

3.1.1 项目的目的

3.1.2 项目的意义

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

3.3 项目现有工作基础

3.4 项目实施目标

3.5 主要研究开发内容

3.5.1 要解决的主要问题

3.5.2 项目概况

3.5.3 课题主要技术关键和创新点

3.5.4 解决措施

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

3.7 年度目标和年度实施计划

3.8 预期主要成果

本章小结

参考文献

习题

第4章 需求分析书案例分析一

4.1 引言

4.1.1 编写目的

4.1.2 背景

4.1.3 定义

4.1.4 所参考资料

4.2 任务概述

4.2.1 目标

4.2.2 用户特点

4.2.3 假定和约束

4.3 需求规定

4.3.1 对功能的规定

4.3.2 对性能的规定

4.4 运行环境规定

4.4.1 设备

4.4.2 支持软件

4.4.3 接口

4.4.4 控制

本章小结

参考文献

习题

第5章 需求分析书案例分析二

5.1 系统概述

5.1.1 系统开发背景

5.1.2 系统描述

5.1.3 系统功能描述

5.1.4 一般约束

5.2 功能和非功能需求

5.2.1 功能模块划分

5.2.2 性能需求