| 类型 | 说明 | 示例 |
|---|
| 显性知识 | 可文档化的知识 | API文档、架构图 |
| 隐性知识 | 经验和直觉 | 排障经验、设计直觉 |
| 过程知识 | 流程和方法 | 发布流程、应急手册 |
| 目标 | 说明 |
|---|
| 知识沉淀 | 将经验转化为文档 |
| 知识发现 | 快速找到所需知识 |
| 知识传播 | 团队共享和传递 |
| 知识更新 | 保持知识时效性 |
| 类别 | 说明 | 示例 |
|---|
| 架构文档 | 系统架构和设计 | ADR、架构图 |
| API文档 | 接口定义 | OpenAPI、gRPC proto |
| 运维文档 | 部署和运维 | Runbook、部署手册 |
| 开发文档 | 开发指南 | 编码规范、开发环境搭建 |
| 业务文档 | 业务逻辑 | 业务流程、术语表 |
| 实践 | 说明 |
|---|
| Markdown格式 | 纯文本，版本可控 |
| 与代码同仓库 | 文档和代码同步更新 |
| CI验证 | 自动检查文档完整性 |
| 自动发布 | 文档自动构建和发布 |
Wiki首页
├── 新人指南
│ ├── 环境搭建
│ ├── 代码规范
│ └── 开发流程
├── 架构文档
│ ├── 系统架构
│ ├── ADR
│ └── 技术选型
├── 运维手册
│ ├── 部署指南
│ ├── Runbook
│ └── On-Call
├── 最佳实践
│ ├── 设计模式
│ ├── 性能优化
│ └── 安全实践
└── 会议记录
├── 技术分享
└── 复盘报告
| 策略 | 说明 |
|---|
| 指定Owner | 每个区域有负责人 |
| 定期审查 | 季度审查文档时效性 |
| 贡献激励 | 鼓励团队成员贡献 |
| 搜索友好 | 标签和索引便于搜索 |
| 形式 | 频率 | 时长 | 适用内容 |
|---|
| 技术分享会 | 每周 | 30-60min | 技术专题 |
| 闪电演讲 | 每周 | 5-10min | 小技巧/工具 |
| 读书会 | 每月 | 60min | 书籍/论文 |
| 代码走读 | 按需 | 30min | 代码设计 |
| 工作坊 | 季度 | 半天 | 实战演练 |
| 实践 | 说明 |
|---|
| 轮流主讲 | 每人都有机会分享 |
| 录制存档 | 方便回看和传播 |
| 互动讨论 | 鼓励提问和讨论 |
| 实践导向 | 结合实际项目 |
| 正向激励 | 认可和奖励分享 |
| 特征 | 说明 |
|---|
| 系统思考 | 看到整体和关联 |
| 自我超越 | 持续学习和成长 |
| 心智模式 | 反思和改进思维 |
| 共同愿景 | 团队共享目标 |
| 团队学习 | 集体智慧提升 |
| 指标 | 说明 |
|---|
| 文档覆盖率 | 关键系统有文档的比例 |
| 文档更新频率 | 文档最近更新的时间 |
| 搜索命中率 | 搜索能找到答案的比例 |
| 分享次数 | 团队知识分享的频次 |