软件文档写作与管理

图书标准信息

• 作者 陈长清
• 出版社 清华大学出版社
• 出版时间 2017-01
• 版次 1
• ISBN 9787302391401
• 定价 29.00元
• 装帧 其他
• 开本 16开
• 纸张 胶版纸
• 页数 199页
• 字数 318千字

【内容简介】

社会的发展对软件工程师提出了越来越高的要求，不仅要求他们具备良好的知识背景、较强的动手能力，还要求他们具有很好的沟通与表达能力。从培养和训练软件工程师的书面沟通能力这一主旨出发，本书介绍了软件技术文档撰写的基本原则、常用的文档类型，以及收集信息和书写文档的策略，以便使读者能按照标准的格式恰当地使用表格、图和参考文献等，书写出清晰、简明和准确的技术文档和个人总结，并能评审书面文档以发现各种问题。本书要求读者具备一定的软件工程知识。

【目录】

目录

第1章软件工程基础

1.1软件与软件工程

1.1.1软件定义与软件特点

1.1.2软件危机与软件工程

1.2软件过程

1.2.1瀑布模型对应的软件过程

1.2.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.3.8软件文档的管理

第2章项目规划类文档写作

2.1项目立项过程

2.2商业计划书

2.2.1商业计划书写作要求

2.2.2商业计划书内容框架

2.3可行性研究报告

2.3.1可行性研究报告写作要求

2.3.2可行性研究报告内容框架

2.4项目方案书

2.4.1项目方案书写作要求

2.4.2项目方案书内容框架

2.5项目开发计划

2.5.1项目开发计划写作要求

2.5.2项目开发计划内容框架

第3章需求类文档写作

3.1需求概述

3.2软件需求的分类

3.3需求过程

3.3.1需求分析

3.3.2需求过程的管理

3.3.3需求获取的流程

3.3.4需求管理的角色

3.4需求说明书的撰写要求

3.4.1需求文档的文字叙述要求

3.4.2对用例说明的要求

3.4.3非功能需求的说明要求

3.5需求说明书内容框架

3.6需求原型工具Axure

第4章设计类文档写作

4.1软件设计过程

4.2软件架构设计

4.2.1架构的概念

4.2.2以架构为中心的迭代开发周期模型

4.2.3领域建模

4.2.4非功能需求驱动的架构设计

4.3软件架构文档

4.3.1软件架构文档写作要求

4.3.2软件架构文档内容框架

4.4概要设计说明书

4.4.1概要设计说明书写作要求

4.4.2概要设计说明书内容框架

4.5详细设计说明书

4.5.1详细设计说明书写作要求

4.5.2详细设计说明书内容框架

4.6数据库设计说明书

4.6.1数据库设计的步骤

4.6.2数据库设计说明书内容框架

4.7用户界面设计文档

第5章测试类文档写作

5.1测试过程

5.1.1测试概述

5.1.2集成测试过程

5.1.3系统测试过程

5.2测试用例的撰写

5.2.1测试用例写作要求

5.2.2测试用例内容框架

5.3测试计划

5.4测试分析报告

第6章项目结束类文档写作

6.1部署过程

6.2用户培训计划

6.3开发组织内部的培训课程

6.4用户手册

6.4.1用户手册要求

6.4.2用户手册内容框架

6.5产品手册要求

6.6项目总结

6.6.1项目总结要求

6.6.2项目总结报告内容框架

第7章项目管理过程类文档写作

7.1项目管理过程

7.2项目风险管理

7.3时间进度管理

7.4项目估算管理

7.5项目管理过程文档

第8章质量保证文档写作

8.1软件质量保证定义

8.2软件质量保证管理

8.2.1SQA过程

8.2.2SQA偏差过程

第9章软件文档配置管理

9.1软件配置管理过程

9.1.1软件配置管理出现的背景

9.1.2软件配置管理发展现状

9.1.3软件配置管理的目的

9.1.4软件配置管理的基本活动

9.2配置管理过程规范

9.2.1配置管理计划

9.2.2实施配置管理

9.3配置管理工具

9.4软件文档的配置管理方案

9.4.1软件配置管理环境的设置

9.4.2软件配置管理机制的组成和建立

9.4.3软件配置管理活动的实施流程

9.4.4软件配置管理基本任务的相关规范

9.4.5配置管理的标识规范

9.4.6配置管理的建议

9.5需求文档变更的管理

9.5.1需求变更的原因

9.5.2需求变更的处理流程

第10章企业软件文档的管理

10.1企业软件文档分类

10.2企业软件文档管理要求

10.3企业软件文档管理流程

10.4项目文档的管理

附录A文档封面模板

附录B项目规划期文档模板

B.1可行性研究报告模板

B.2项目方案书模板

附录C需求类文档模板

C.1需求调研报告

C.2需求规格说明书

C.3用例使用场景模版与实例

C.4用例描述模板

C.5需求评审报告

C.6需求分析报告检查表

附录D文档设计模板

D.1软件架构设计说明书

D.2概要设计说明书

D.2.1模板1

D.2.2模板2

D.3详细设计说明书

D.3.1模板1

D.3.2模板2

D.4数据库设计说明书

附录E设计文档模板

E.1软件配置管理规范

E.2软件修改报告

附录F单元测试报告文档模板

附录G项目管理文档模板

G.1风险列表

G.2周报

附录H质量保证文档模板

H.1质量保证计划

H.2SQA汇总报告

H.3SQA每周报告

H.4SQA偏差报告

附录I软件文档评分标准

参考文献