module6
60 分钟

知识沉淀与复用

学习进度

当前模块0/6 课
总进度0/36 课
学习时长0 分钟

学习目标

  • 建立团队 Prompt 和指令模板库
  • 构建常见解决方案知识库
  • 设计新成员快速上手流程
  • 建立内部分享和知识传承机制

505 知识沉淀与复用

构建团队的 AI 知识资产:模板库、解决方案库、内部技术分享

学习目标

完成本课程后,你将能够:

一、模板库建设

模板库架构

team-templates/
├── instructions/           # 指令模板(给 Codex 的)
│   ├── crud-api.md        # CRUD API 生成
│   ├── react-component.md # React 组件生成
│   ├── database-migration.md # 数据库迁移
│   ├── unit-test.md       # 单元测试生成
│   └── bug-analysis.md    # Bug 分析报告
├── solutions/             # 解决方案模板(给人看的)
│   ├── auth-flow.md       # 认证流程实现
│   ├── file-upload.md     # 文件上传方案
│   ├── realtime-sync.md   # 实时同步方案
│   └── pagination.md      # 分页方案对比
└── checklists/            # 检查清单
    ├── code-review.md     # 代码审查清单
    ├── deployment.md      # 上线检查清单
    └── security.md        # 安全检查清单

指令模板示例

# instructions/crud-api.md

## CRUD API 生成指令

请为 {MODEL_NAME} 模型生成完整的 RESTful API:

### 基本信息
- 模型名:{MODEL_NAME}
- 所属模块:{MODULE}
- 权限要求:{AUTH_LEVEL}

### 生成内容
1. Prisma Schema(如需要)
2. Zod 验证 Schema
3. Express 路由文件
4. 控制器(Controller)
5. 服务层(Service)
6. Swagger 文档注解
7. 集成测试

### 代码规范
- 使用 `AppError` 处理业务异常
- 所有 API 返回 `{ success, data, error? }` 格式
- 列表接口使用游标分页(cursor-based)
- 敏感操作记录审计日志

### 验收标准
- [ ] 所有测试通过
- [ ] 通过 ESLint 检查
- [ ] 无 TypeScript 错误
- [ ] API 文档可正常访问

解决方案模板示例

# solutions/file-upload.md

## 文件上传方案

### 场景
用户上传任务附件,支持图片、PDF、Office 文档。

### 技术选型
- 前端:React Dropzone + 分片上传
- 后端:Multer + S3 直传
- 存储:S3 兼容服务(MinIO 本地开发)

### 核心流程
1. 前端请求预签名 URL(GET /api/upload/presign)
2. 前端直传文件到 S3
3. 上传完成后回调后端(POST /api/upload/complete)
4. 后端验证文件、生成缩略图、更新数据库

### 代码位置
- 前端:`frontend/src/components/upload/`
- 后端:`backend/src/services/upload.service.ts`
- 路由:`backend/src/routes/upload.routes.ts`

### 注意事项
- 文件大小限制:图片 10MB,文档 50MB
- 类型白名单:jpg, png, pdf, docx, xlsx
- 病毒扫描:上传后接入 ClamAV

二、解决方案知识库

知识库搭建

知识库工具选型:
- 小团队(< 20 人):Git 仓库 Markdown
- 中型团队(20-100 人):Notion / Confluence
- 大型团队(> 100 人):自建文档站点(Docusaurus / VitePress)

知识分类

知识库分类体系:

1. 架构与设计
   - 系统架构文档
   - 技术选型记录(ADR)
   - API 设计规范

2. 开发指南
   - 环境搭建
   - 常用命令
   - 调试技巧

3. 常见问题
   - 环境问题
   - 构建问题
   - 部署问题
   - 性能问题

4. 最佳实践
   - Codex 使用技巧
   - 代码审查经验
   - 性能优化案例

5. 复盘与总结
   - 事故复盘报告
   - 项目总结
   - 技术调研报告

ADR(架构决策记录)

# ADR-001: 选择 Prisma 作为 ORM

## 状态
已采纳(2026-01-15)

## 背景
需要选择一个 TypeScript 友好的 ORM。

## 决策
选择 Prisma,原因:
1. 类型安全:自动生成 TypeScript 类型
2. 迁移管理:内置迁移工具
3. 查询优化:自动处理 N+1
4. 生态兼容:支持 PostgreSQL、MySQL、SQLite

## 替代方案
- TypeORM:更灵活但类型推导较弱
- Drizzle:更轻量但生态较新
- Knex.js:查询构建器,需搭配 Objection.js

## 影响
- 学习成本:需要学习 Prisma Schema 语法
- 性能:复杂查询可能需要 raw query 补充
- 工具链:Prisma Studio 方便开发调试

三、新成员入职流程

入职路径

Day 1-3:环境与基础
  □ 开发环境搭建
  □ 阅读架构文档
  □ 完成新人练习项目
  □ 学习 Codex 基础命令

Week 1-2:融入开发
  □ 与 Buddy 结对编程
  □ 完成 3 个 Good First Issue
  □ 参与 Code Review
  □ 学习团队模板使用

Week 3-4:独立贡献
  □ 独立完成一个 Feature
  □ 撰写一篇内部分享
  □ 参与技术方案评审
  □ 输出新人体验反馈

Buddy 制度

Buddy 的选择标准:
- 在团队至少 6 个月
- 熟悉项目架构和 Codex 使用
- 乐于分享和指导
- 沟通能力强

Buddy 的核心职责:
- 每日 15 分钟站会同步进度
- 前 10 个 PR 的代码审查
- 解答技术和工具问题
- 引导使用团队知识库

Buddy 激励:
- 绩效加分
- 首次担任 Buddy 有 Mentor 培训
- 优秀 Buddy 季度表彰

四、内部技术分享

分享体系设计

频率类型时长参与方式
每周Lightning Talk15 分钟轮流,自愿报名
双周技术深潜45 分钟主题申报
每月Codex 技巧分享30 分钟所有人参与
每季度项目复盘60 分钟项目负责人

分享主题库

Codex 使用技巧分享主题:

- "我用 Codex 一天完成了一个微服务"
- "AI 生成代码的 10 个常见陷阱"
- "如何写出高质量的 Codex Prompt"
- "Codex + Cursor 的最佳组合实践"
- "用 Codex 重构遗留代码的实战经验"
- "从 Claude Code 迁移到 Codex 的 30 天"

知识传承机制

经验 → 分享文档 → 模板/解决方案 → 自动化检查 → 新人培训材料

每级抽象提升复用效率:
- 个人经验:口头传播,效率 ×1
- 分享文档:团队可见,效率 ×5
- 模板化:直接使用,效率 ×20
- 自动化:强制执行,效率 ×50
- 培训材料:新人即用,效率 ×100

五、实战练习

练习 1:建立模板库

为你的团队创建至少 5 个指令模板:
- CRUD API 生成
- React 组件创建
- 单元测试编写
- Bug 修复流程
- 数据库迁移

练习 2:撰写 ADR

为你团队最近的一个技术决策撰写 ADR,包含:
- 背景和问题
- 候选方案对比
- 决策和理由
- 影响和后续

练习 3:设计分享计划

为你团队设计本季度的技术分享计划:
- 至少 4 个主题
- 指定分享人
- 设计互动环节

六、本课总结

**核心要点:**

  • 模板库是团队 AI 能力的放大器:写好一次,全员复用
  • 解决方案库沉淀踩坑经验,避免重复试错
  • ADR 记录关键技术决策,新人可追溯历史背景
  • Buddy 制降低入职门槛,前 10 个 PR 专人把关
  • 内部分享形成正向循环:使用 → 总结 → 分享 → 更多人使用

**下一步:** 模块 506 — 企业级落地路线图

下一模块