软件文档写作与管理

本书特色

[

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

]

内容简介

[

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

]

目录

目录第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模板1D.2.2模板2D.3详细设计说明书D.3.1模板1D.3.2模板2D.4数据库设计说明书附录E设计文档模板E.1软件配置管理规范E.2软件修改报告附录F单元测试报告文档模板附录G项目管理文档模板G.1风险列表G.2周报附录H质量保证文档模板H.1质量保证计划H.2SQA汇总报告H.3SQA每周报告H.4SQA偏差报告附录I软件文档评分标准参考文献

封面

书名:软件文档写作与管理

作者:陈长清

页数:199

定价:¥29.0

出版社:清华大学出版社

出版日期:2017-02-01

ISBN:9787302391401

PDF电子书大小:56MB 高清扫描完整版