内容演进规范 - PDCA持续改进
概述
当发现文档有问题或需要改进时,使用PDCA循环进行系统性的内容演进。
PDCA循环
Plan(计划)- 分析问题,制定方案
做什么:
- 明确问题:具体哪里有问题,为什么需要改进
- 分析原因:问题的根本原因是什么
- 制定方案:怎么改进,涉及哪些文档
检查要点:
- [ ] 问题描述清楚了吗?
- [ ] 改进目标明确了吗?
- [ ] 需要修改的文档列出了吗?
Do(执行)- 实施改进
做什么:
- 按方案执行具体的文档修改
- 确保修改符合现有规范
- 保持版本控制和记录
检查要点:
- [ ] 按计划完成修改了吗?
- [ ] 符合文档规范吗?
- [ ] Git提交记录清晰吗?
Check(检查)- 验证效果
做什么:
- 检查改进是否解决了原问题
- 评估是否引入了新问题
- 确认整体质量提升
检查要点:
- [ ] 原问题解决了吗?
- [ ] 有产生新问题吗?
- [ ] 整体质量提升了吗?
Act(行动)- 固化经验
做什么:
- 总结这次改进的经验
- 更新相关规范(如需要)
- 避免类似问题再次发生
检查要点:
- [ ] 经验总结了吗?
- [ ] 需要更新规范吗?
- [ ] 预防措施到位了吗?
实际案例
案例1:Products层定位误解
Plan阶段
- 问题:Git规范被误分到Products层,造成定位混淆
- 原因:术语表中Products层定义不够明确,缺少边界说明
- 方案:完善术语表、增加判断决策树、补充检查清单
Do阶段
- 修改术语表,明确Products层边界定义
- 更新内容定位规范,添加判断决策树和示例
- 完善文档校验规范,增加定位检查点
Check阶段
- 原问题解决:Products层边界现在很清楚
- 无新问题:修改符合现有规范
- 质量提升:未来不会再有类似误解
Act阶段
- 经验:需要在规范中明确边界和判断标准
- 预防:建立了系统的检查机制
- 固化:更新了相关规范文档
案例2:PSO定义不统一(2025-01-14)
Plan阶段
- 问题:PSO定义分散(pso.yml vs frontmatter),格式不统一
- 原因:初期设计时没有统一考虑文档级和目录级的PSO
- 方案:统一PSO到frontmatter,创建目录索引规范
Do阶段
- 更新内容定位规范,统一PSO定义到frontmatter
- 创建目录索引规范,明确index.md的要求
- 移除pso.yml的相关说明,简化管理
Check阶段
- 原问题解决:PSO定义现在完全统一
- 无新问题:更简洁、更一致
- 质量提升:管理更简单,理解更容易
Act阶段
- 经验:设计要追求简洁统一,避免多套标准
- 预防:通过index.md强制目录必须有索引
- 固化:创建了目录索引规范,更新了内容定位规范
案例3:PSO excludes 理念纠正(2025-01-14)
Plan阶段
- 问题:PSO 的 excludes 部分误用了链接,混淆了概念边界和内容引用
- 原因:对 PSO 的本质理解有偏差,excludes 应该定义概念边界而非提供导航
- 方案:纠正 PSO excludes 的定义,明确其作为概念边界说明的本质
Do阶段
- 更新内容定位规范,明确 excludes 是概念性边界定义
- 修改示例,展示正确的 excludes 用法(注释说明而非链接)
- 更新现有文档,将链接改为概念说明
Check阶段
- 原问题解决:excludes 回归其概念边界的本质
- 无新问题:边界定义更清晰
- 质量提升:PSO 更聚焦于定位而非导航
Act阶段
- 经验:要正确理解每个规范元素的本质用途,不要混淆不同功能
- 预防:在规范中明确强调 excludes 是概念边界,不是内容导航
- 固化:更新了内容定位规范,明确了 excludes 的正确用法
触发条件
什么时候启动PDCA?
- 发现文档定位不准确
- 用户反馈内容有问题
- 定期审查发现改进点
- 需求或环境发生变化
优先级判断
- 紧急重要:立即影响使用 → 立即处理
- 重要不紧急:长期价值 → 计划处理
- 不重要:记录备案 → 有空处理
简单工具
PDCA记录模板
markdown
## 内容改进记录
### Plan
**问题**:[描述具体问题]
**原因**:[分析根本原因]
**方案**:[改进计划]
### Do
**执行**:[具体做了什么]
**修改**:[涉及哪些文档]
### Check
**效果**:[问题解决了吗]
**质量**:[整体是否更好]
### Act
**经验**:[学到了什么]
**预防**:[如何避免再犯]快速检查清单
改进前:
- [ ] 问题明确了吗?
- [ ] 方案可行吗?
改进中:
- [ ] 按计划执行了吗?
- [ ] 符合规范吗?
改进后:
- [ ] 问题解决了吗?
- [ ] 经验总结了吗?
记录和学习
每次PDCA完成后:
- 简单记录过程和结果
- 更新相关规范(如需要)
- 分享经验给团队
记住:PDCA就是简单的"发现问题 → 计划改进 → 执行改进 → 检查效果 → 固化经验"的循环。

