课程简介
在敏捷实践越来越深入和普及的现代化研发团队,随着团队规模的发展和项目规模的变大,逐渐出现了敏捷轻文档和高复杂度项目需要文档规范之间的矛盾。前线员工越忙就越没时间写文档,项目参与人数越多就越增加了对文档的需求。本课程围绕文档对项目的核心价值,谨慎控制文档的数量、重点聚焦文档的质量。由讲师的实际项目经验,分享敏捷、效率、文档、规范之间的平衡策略,有当堂演示讲师的实际项目文档管理成果。并分享文档背后更深层次的如何系统化、结构化地梳理思路、做好设计,以及跨团队协作时的文档内容评审确认机制。尽量在有限的时间投入下,尽可能最大化文档价值输出对项目的未来指引、执行保证、各方共识以及知识传承,既不会堕入重型文档的枷锁,也不会任由完全反文档的失控。
目标收益
1、掌握文档精简方法:学会如何在敏捷开发中平衡文档数量与质量。
2、提升文档复用性:通过模板和架构设计提高文档的通用性和效率。
3、明确文档核心价值:理解文档对项目执行、共识和知识传承的作用。
4、优化文档确认流程:掌握需求、设计、测试、运维文档的确认实践。
5、避免文档管理误区:从讲师亲身经历中反思重型文档与无文档的代价。
6、构建文档生命周期管理:学习如何归档、维护和测试文档,确保长期价值。
培训对象
1、研发团队成员:包括开发、测试、运维等技术人员。
2、项目经理:负责项目管理和跨团队协作的人员。
3、技术团队负责人:需要制定研发规范和文档策略的管理者。
4、敏捷实践者:希望在敏捷开发中优化文档管理的团队成员。
5、文档管理人员:负责文档编写、审核和维护的人员。
6、新入职员工:需要快速上手项目文档的新人。
课程大纲
文档的价值与代价 |
1、后敏捷时代重新思考文档的价值 -传统方法太依赖文档;敏捷太反对文档,从一个极端跳到另一个极端的代价与反思 -实例分享:讲师在两家公司的亲身经历: (1)重型文档带来的痛苦、(2)完全反文档付出的代价 -文档:对大团队和小团队是不同的概念 -何为成熟团队的“刚刚好”的文档 2、哪些文档该精简、哪些文档该发力 -讨论:如何定义“没用的”文档 -如何定义必须的文档 -必须遵守的规范 -经常查阅的手册 -必须记录的要项 -不能靠口头传达的规格 3、文档哲学 -文档是对过去的记录? -文档是对未来的指导? -文档是结论? -文档是讨论? |
第一步:文档清晰 |
1、文档不写则以,写则清晰 -文档清晰的管理标准 -文档与流程的结合 -实例分享:需求、开发、测试、运维天天互相撕,都要求对方“立字据”! -反思与解决 2、高质量文档模板 -需求文档清晰度及稳定度考量 -高质量设计文档书写技巧 -高质量测试文档核心价值点 -高质量运维文档要素 3、信息完备度 -操作系统级别的软件,如何做到任何一个细节都有据可查 |
第二步 文档确认 |
1、文档的确认 -对需求文档的确认流程实践 -对设计文档的确认流程实践 -对测试文档的确认流程实践 -对运维文档的确认流程实践 2、文档的生命周期管理 -工具分享:用什么工具管理文档 -文档的状态定义及管理 -文档不能写完白写,文档是后续工作的指导和规范 -文档的归档 3、用户文档的测试 -用户文档的书写分工 -多语言用户文档的翻译及管理 -用户文档的测试 |
第三步 文档简化 |
提升文档的复用性 -精雕模板、以一挡百 -技能转换、经验共享 -文档也有架构、通用及分层 -从需求到测试,一“板”到底 |
文档类型 |
1、研发技术类文档 -实例分享:研发过程文档有哪些必须的文档类型 -实例分享:研发规范性文档有哪些必须的文档类型 -运维及基础设施有哪些必须的文档类型 2、团队日常管理文档 -员工入职离职的组内准备项文档 -新人入职(技术岗)快速上手的文档及实践 3、工具使用类的文档 -版本管理工具文档 -文档管理工具文档 -公司内部系统使用文档 |
总结 |
1、高质量的文档是积累出来的,不是赶工赶出来的 2、总结本课提到的每种文档由谁来写 3、实例分享:我们文档虽多,但每个人文档负担不重。在时间上、空间上拉松,永远重视文档的质量多过数量 4、精简、有深度的文档是一种修养 |
文档的价值与代价 1、后敏捷时代重新思考文档的价值 -传统方法太依赖文档;敏捷太反对文档,从一个极端跳到另一个极端的代价与反思 -实例分享:讲师在两家公司的亲身经历: (1)重型文档带来的痛苦、(2)完全反文档付出的代价 -文档:对大团队和小团队是不同的概念 -何为成熟团队的“刚刚好”的文档 2、哪些文档该精简、哪些文档该发力 -讨论:如何定义“没用的”文档 -如何定义必须的文档 -必须遵守的规范 -经常查阅的手册 -必须记录的要项 -不能靠口头传达的规格 3、文档哲学 -文档是对过去的记录? -文档是对未来的指导? -文档是结论? -文档是讨论? |
第一步:文档清晰 1、文档不写则以,写则清晰 -文档清晰的管理标准 -文档与流程的结合 -实例分享:需求、开发、测试、运维天天互相撕,都要求对方“立字据”! -反思与解决 2、高质量文档模板 -需求文档清晰度及稳定度考量 -高质量设计文档书写技巧 -高质量测试文档核心价值点 -高质量运维文档要素 3、信息完备度 -操作系统级别的软件,如何做到任何一个细节都有据可查 |
第二步 文档确认 1、文档的确认 -对需求文档的确认流程实践 -对设计文档的确认流程实践 -对测试文档的确认流程实践 -对运维文档的确认流程实践 2、文档的生命周期管理 -工具分享:用什么工具管理文档 -文档的状态定义及管理 -文档不能写完白写,文档是后续工作的指导和规范 -文档的归档 3、用户文档的测试 -用户文档的书写分工 -多语言用户文档的翻译及管理 -用户文档的测试 |
第三步 文档简化 提升文档的复用性 -精雕模板、以一挡百 -技能转换、经验共享 -文档也有架构、通用及分层 -从需求到测试,一“板”到底 |
文档类型 1、研发技术类文档 -实例分享:研发过程文档有哪些必须的文档类型 -实例分享:研发规范性文档有哪些必须的文档类型 -运维及基础设施有哪些必须的文档类型 2、团队日常管理文档 -员工入职离职的组内准备项文档 -新人入职(技术岗)快速上手的文档及实践 3、工具使用类的文档 -版本管理工具文档 -文档管理工具文档 -公司内部系统使用文档 |
总结 1、高质量的文档是积累出来的,不是赶工赶出来的 2、总结本课提到的每种文档由谁来写 3、实例分享:我们文档虽多,但每个人文档负担不重。在时间上、空间上拉松,永远重视文档的质量多过数量 4、精简、有深度的文档是一种修养 |