金字塔原理与软件项目文档写作技巧

|编号：ITOP-07课时：12小时/2天 |
|金字塔原理与软件项目文档写作技巧V1.5 |
| |
|----提高软件项目文档写作技能 |

|课程前言 |

在软件文档编写时，有时有话要说，却不知所措；有时千言万语，却找不到顺序；有
时内容丰富，阅读者不知所云；有时找个模板，却不知该如何去填。软件文档，是软件
研发过程中关键的信息载体，是项目管理沟通、开发的依据，是项目成功关键之一。软
件文档不仅反映了作者的能力水平，更是项目产品的生产根据之一，在组织不同的层别
中，其作用意义各不相同，它是重要的、常用的信息载体之一。

本课程介绍金字塔原理--
思考、写作、解决问题的逻辑，国内大型CMMI企业文档模板及近百份最佳实践文档实例
，敏捷开发思想对文档的挑战，结合讲师十几年软件行业经验及的文档审计经验，共同
探讨软件文档的编写之道，帮助研发人员编写高质量的软件文档，建立企业的文档层级
和结构。

|特色收益 |

←
理论联系实际：学习《金字塔原理》一书管理思想，与软件文档的编写相结合；
←
文档系统化：全面介绍管理体系的文件级别及文档架构，对软件文档有立体的认
识；
← 典型文档模板：展示通过CMMI5持续改进的文档模板、经典案例；
←
最佳实践实例：从上百个项目实践中、从组织级财富库，精选典型的实践实例；


← 文档与应用结合：不因为讲文档而文档，阐述各文档的作用、意见、流向。
|课程对象 |


项目经理、需求分析工程师、系统设计工程师、软件开发工程师、软件测试工程师、
系统维护工程师、质量保证工程师、配置管理工程师、过程改进工程师等兴趣爱好者。


|课程大纲 |


第1天 09：00——17：00
第1章 金字塔原理----学习目标：掌握金字塔的写作原理、方法、结构
□ 文档的作用意义
□ 表达过程中常出现的问题
□ 如何才能讲清楚、写明白
□ 培养结构化的思维方式
□ 结构化表达的四个原则
□ 自上而下
□ 层次清晰的表达原则
□ 结构简单的表达原则
□ 重点突出的表达原则
□ 重点突出的表达技巧
□ 如何进行结构化的表达
□ 演绎的表达方式
□ 归纳的表达方式
□ 如何进行书面/口头表达
案例分析：正反面案例


□ 如何进行结构化表达
□ 要有一个清晰的中心思想
□ 自上而下的表达
□ 分组表达
□ 表达与汇报思路
□ 用图表说话
□ 小结


第2章 体系文档层级及文档管理----
学习目标：理解体系文档的层级、结构及各类文档的作用意义，掌握文档评估、
复用、管理的方法措施
□ 体系的来源
□ 体系文档的层级及结构
□ 各层级文档的作用间义
□ 层级文档案例说明
□ 一级文级
□ 二级文级
□ 三级文级
□ 文档的质量评估标准
□ 软件文档的配置管理
□ 软件文档的评审
□ 文档编写常见的问题
□ 文档复用的方法技巧
□ 项目文档的剪裁
□ 小结

第3章 软件文档编写技巧（组织管理）----
学习目标：理解组织管理过程文档编写方法技巧。重点涉及组织管理、内审管理
、文档控制、文档体系等。
□ 组织管理过程文档
□ 质量目标管理文档
□ 过程定义和改进文档
□ 内部质量体系审核文档
□ 质量记录控制文档

第4章 软件文档编写技巧（项目管理）----
学习目标：理解项目管理过程文档编写方法技巧。重点涉及项目启动、项目策划
、项目结束等关键文档。
□ PMP与PRINCE2简介
□ 软件项目管理简介
□ 软件项目管理过程文档
□ 项目合同管理文档
□ 项目启动管理文档
□ 项目计划管理文档
项目计划
项目从属计划
项目过程裁剪文档
练习：项目过程书和项目计划


□ 项目质量保证文档
□ 项目过程监控文档
□ 项目分包控制文档
□ 项目验收交付文档
□ 项目总结评价文档
项目结项申请
项目结项报告
□ 案例分析：基于CMMI5裁剪的WS事业部项目管理规范

第2天 09：00——17：00
第5章 软件文档编写技巧（软件工程）----
学习目标：理解工程管理过程文档编写方法技巧。
□ 软件研发模型简介
□ 软件工程过程简介
□ 软件产品立项文档
项目立项报告
□ 软件需求文档
用户需求说明书
需求变更报告
需求跟踪矩阵
练习：绘制完整的业务流程图，掌握软件文档的核心思想
案例分析：《上海XX交通网络监控方案编写案例分析》与《XXXX
ERP软件需求规格说明书编写案例分析》。
□ 软件设计文档
详细设计说明书
数据库说明书
PDM
□ 软件测评与实现
用户操作手册
软件测试用例
软件测试报告
练习：编写测试用例


第6章 软件文档编写技巧（支持管理、服务管理）----
学习目标：理解支持管理、服务管理过程文档编写方法技巧。
□ ITIL与ITSM简介
□ 服务提供文档
服务级别协议
服务目录
服务报告
用户投诉处理表
客户回访单
□ 服务支持文档
事件和服务请求处理单
重大事件报告
问题单模板
变更&发布单
软件发布申请单
□ 小测验：《金字塔原理与软件项目文档写作技巧 测验》

第7章 软件文档最佳实践----
学习目标：了解CMMI5持续改进文档模板与最佳案例。
□ CMMI简介
□ CMMI案例文档展示
□ 文档财富库
□ 工程类文档
□ 案例分析：CMMI5参评项目体系文档模板

第8章 真的需要很多文档----
学习目标：剖析敏捷开发思想，挑战传统的文档，提炼一套项目文档。
□ 什么是敏捷AGILE？
□ 敏捷AGILE思想SCRUM方法简介
□ 敏捷开发的文档
□ 敏捷开发文档VS CMMI模型文档
□ 研讨：
1. 所有项目文档要求都是一样的吗？
2.
一个项目最低配置的文档是哪些？不同项目的文档数量要求是什么？质量等级
要求是什么？
□ 观点：建立一套组织级、项目级的文档规范。

李远佳老师的其它课程