您现在的位置: 首页 > 培训业务 > 研发技术操作类
金字塔原理与软件项目文档写作技巧(医疗器械适用)
来源:科济管线咨询 作者:admin 关注: 次 更新时间:2021-12-26
作者:admin 关注:189次 更新时间:2021-12-26

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

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

在软件文档编写时,有时有话要说,却不知所措;有时千言万语,却找不到顺序;有时找个模板,却不知该如何去填。软件文档,是软件研发过程中关键的信息载体,是项目管理沟通、开发的依据,是项目成功关健之一。软件文档不仅反映了作者的能力水平,更是项目产品的生产根据之一,是沟通交流的重要信息载体。

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

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

理论联系实际:学习《金字塔原理》一书管理思想,与软件文档的编写相结合;

文档系统化:全面介绍管理体系的文件级别及文档架构,对软件文档有立体的认识;

典型文档模板:展示通过CMMI5持续改进的文档模板、经典案例;

最佳实践实例:从上百个项目实践中、从组织级财富库,精选典型的实践实例; 

文档与应用结合:不因为讲文档而文档,阐述各文档的作用、意见、流向。

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

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

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

第1章 金字塔原理----学习目标:掌握金字塔的写作原理、方法、结构

一、文档的作用意义

1.表达过程中常出现的问题

2.如何才能讲清楚、写明白

3.培养结构化的思维方式

4.结构化表达的四个原则

5.自上而下

6.层次清晰的表达原则

7.结构简单的表达原则

8.重点突出的表达原则

9.重点突出的表达技巧

10.如何进行结构化的表达

11.演绎的表达方式

12.归纳的表达方式

13.如何进行书面/口头表达

14.案例分析:正反面案例


二、如何进行结构化表达

1.要有一个清晰的中心思想

2.自上而下的表达

3.分组表达

4.表达与汇报思路

5.用图表说话

6.小结


第2章 体系文档层级及文档管理----学习目标:理解体系文档的层级、结构及各类文档的作用意义,掌握文档评估、复用、管理的方法措施

1.体系的来源

2.体系文档的层级及结构

3.各层级文档的作用间义

4.层级文档案例说明

5.一级文级

6.二级文级

7.三级文级

8.文档的质量评估标准

9.软件文档的配置管理

10.软件文档的评审

11.文档编写常见的问题

12.文档复用的方法技巧

13.项目文档的剪裁

14.小结


第3章 软件文档编写技巧(组织管理)---- 学习目标:理解组织管理过程文档编写方法技巧。重点涉及组织管理、内审管理、文档控制、文档体系等。

1.组织管理过程文档

2.质量目标管理文档

3.过程定义和改进文档

4.内部质量体系审核文档

5.质量记录控制文档


第4章 软件文档编写技巧(项目管理)---- 学习目标:理解项目管理过程文档编写方法技巧。重点涉及项目启动、项目策划、项目结束等关键文档。

一、PMP与PRINCE2简介

1.软件项目管理简介

2.软件项目管理过程文档

3.项目合同管理文档

4.项目启动管理文档

5.项目计划管理文档

6.项目计划

7.项目从属计划

8.项目过程裁剪文档

9.练习:项目过程书和项目计划


二、项目质量保证文档

1.项目过程监控文档

2.项目分包控制文档

3.项目验收交付文档

4.项目总结评价文档

5.项目结项申请

6.项目结项报告

7.案例分析:基于CMMI5裁剪的WS事业部项目管理规范



第5章 软件文档编写技巧(软件工程)----学习目标:理解工程管理过程文档编写方法技巧。

1.软件研发模型简介

2.软件工程过程简介

3.软件产品立项文档

4.项目立项报告

5.软件需求文档

6.用户需求说明书

7.需求变更报告

8.需求跟踪矩阵

9.练习:绘制完整的业务流程图,掌握软件文档的核心思想

10.案例分析:《上海XX交通网络监控方案编写案例分析》与《XXXX ERP软件需求规格说明书编写案例分析》。

11.软件设计文档

12.详细设计说明书

13.数据库说明书

14.PDM

15.软件测评与实现

16.用户操作手册

17.软件测试用例

18.软件测试报告

19.练习:编写测试用例


第6章 软件文档编写技巧(支持管理、服务管理)----学习目标:理解支持管理、服务管理过程文档编写方法技巧。

1.ITIL与ITSM简介

2.服务提供文档

3.服务级别协议

4.服务目录

5.服务报告

6.用户投诉处理表

7.客户回访单

8.服务支持文档

9.事件和服务请求处理单

10.重大事件报告

11.问题单模板

12.变更&发布单

13.软件发布申请单

14.小测验:《金字塔原理与软件项目文档写作技巧 测验》


15.第7章 软件文档最佳实践----学习目标:了解CMMI5持续改进文档模板与最佳案例。

16.CMMI简介

17.CMMI案例文档展示

18.文档财富库

19.工程类文档

20.案例分析:CMMI5参评项目体系文档模板


第8章 真的需要很多文档----学习目标:剖析敏捷开发思想,挑战传统的文档,提炼一套项目文档。

1.什么是敏捷AGILE?

2.敏捷AGILE思想SCRUM方法简介

3.敏捷开发的文档

4.敏捷开发文档VS CMMI模型文档

5.研讨:

6.所有项目文档要求都是一样的吗?

7.一个项目最低配置的文档是哪些?不同项目的文档数量要求是什么?质量等级要求是什么?

8.观点:建立一套组织级、项目级的文档规范。

END·······

电话:400-1818-716
CORGI博士电话:139-1778-1758
邮箱:office@corgipipeline.com
地址:重庆市南岸区中国智谷力和创新中心四单元三楼
版权所有 Copyright © 2010-2021 corgipipeline.com All Rights Reserved
沪ICP备2021008520号
扫码关注公众号
Copyright © 2021 Corgipipeline LTD. All rights reserved.
沪ICP备2021008520号
X

截屏,微信识别二维码

微信号:jiangxinan616

(点击微信号复制,添加好友)

  打开微信 

微信号已复制,请打开微信添加咨询详情!