From 0dcd96d0ff32eea68b9125b05b9d4e2554b658e4 Mon Sep 17 00:00:00 2001 From: showen Date: Thu, 12 Mar 2026 06:52:15 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E5=AE=8C=E5=96=84=E6=B2=9F=E9=80=9A?= =?UTF-8?q?=E5=92=8C=E8=AE=B0=E5=BD=95=E8=A7=84=E8=8C=83?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 新增 COMMUNICATION.md： - 沟通方式详细说明（异步/实时/代码/文档） - 记录规范和格式要求 - 必须记录的内容（技术决策、需求变更、架构调整、Bug、经验） - 记录管理（位置、检索、归档） - 沟通礼仪（提问技巧、回复规范、协作态度） - 完整的沟通示例 更新 TEAM.md： - 新增沟通方式和记录要求章节 - 明确异步沟通（推荐）和实时沟通（可选） - 强调实时沟通后必须记录要点 - 详细的记录格式和规范 更新 TEAM_CHAT.md： - 新增沟通方式说明 - 明确记录要求（必须记录 vs 可以不记录） - 统一记录格式 核心原则： - 扁平化沟通，但必须有记录 - 实时沟通后必须记录要点和决策 - 重要信息必须可追溯 - 知识通过记录沉淀和传承 --- COMMUNICATION.md | 335 +++++++++++++++++++++++++++++++++++++++++++++++ TEAM.md | 58 ++++++++ TEAM_CHAT.md | 36 +++++ 3 files changed, 429 insertions(+) create mode 100644 COMMUNICATION.md diff --git a/COMMUNICATION.md b/COMMUNICATION.md new file mode 100644 index 0000000..3ef46a4 --- /dev/null +++ b/COMMUNICATION.md @@ -0,0 +1,335 @@ +# ShowenV2 沟通和记录规范 + +## 沟通原则 + +### 核心理念 +- **扁平化**: 员工之间直接沟通，不需要层层汇报 +- **透明化**: 重要信息必须记录，所有人可见 +- **可追溯**: 决策和讨论有据可查 +- **知识沉淀**: 经验和方案通过记录传承 + +--- + +## 沟通方式 + +### 1. 异步沟通（推荐） + +#### 工具 +- **TEAM_CHAT.md** - 团队沟通主渠道 +- **Git commit** - 代码变更说明 +- **文档** - PRD、技术设计文档、API 文档 + +#### 适用场景 +- 技术讨论和方案设计 +- 需求澄清和变更 +- 问题反馈和解决方案 +- 经验分享和最佳实践 +- 跨团队协作 + +#### 优点 +- ✅ 自动记录，可追溯 +- ✅ 可搜索，易查找 +- ✅ 异步处理，不打断工作 +- ✅ 深度思考，质量更高 + +#### 记录格式 +```markdown +[时间] 发送者 → 接收者: 内容 + +示例： +[14:30] 李思琪(视频工程师) → 王浩然(网络工程师): +视频流传输性能问题已解决，采用零拷贝方案。 +- 参考代码：src/plugins/video/processor.rs:456 +- 性能提升：从 30fps 提升到 60fps +- 关键技术：tokio::fs::File + 流式传输 +``` + +--- + +### 2. 实时沟通（可选） + +#### 工具 +- **kilo 命令** - 启动子任务进行实时协作 +- **语音/视频会议** - 复杂问题讨论 +- **屏幕共享** - 代码调试和演示 + +#### 适用场景 +- 紧急问题需要快速解决 +- 复杂技术方案需要深入讨论 +- 头脑风暴和创意碰撞 +- 代码调试和问题定位 + +#### 记录要求 +**重要**：实时沟通后必须在 TEAM_CHAT.md 记录要点 + +```markdown +[时间] 会议记录 - [主题] +参与人：[人员列表] +讨论内容： +1. 问题描述 +2. 讨论要点 +3. 决策结果 +4. 行动计划 +``` + +--- + +### 3. 代码协作 + +#### 工具 +- **Git commit message** - 代码变更说明 +- **代码注释** - 复杂逻辑说明 +- **Pull Request** - 代码审查和讨论 + +#### 记录要求 + +##### Commit Message 规范 +``` +: + + + +