ce-compound 是做什么的?
将最近解决的问题记录为团队知识积累,或更新 CONCEPTS.md 以维护项目的共享领域词汇。
背景
在开发过程中,我们会遇到各种复杂问题。这些问题往往花费数小时甚至数天才能解决,但解决方案常常被遗忘在 Git 提交记录中,或者只停留在开发者的个人笔记里。这种知识是隐性的、易流失的。
技能价值
- 知识复合:将一次性的问题解决方案转化为可复用的团队知识资产。
- 降低重复劳动:当团队成员遇到类似问题时,可以直接参考已有的解决方案,不必从头开始排查。
- 统一语言:通过维护 CONCEPTS.md,确保项目组使用一致的术语,减少沟通误解。
工作方式
该技能主要通过两个文件来管理知识:
-
知识文档:一个或多个 Markdown 文件,每个文件记录一个具体的问题及其解决方案。文件名通常以问题主题命名(例如
fix-macos-usb-detection.md)。 -
CONCEPTS.md:项目根目录下的一个文件,用于定义和解释项目中使用的核心概念、模式、术语和架构决策。
触发条件
AI 代理会在以下情况下被激活:
- 用户明确要求“记录这个问题”或“将此写入 CONCEPTS.md”。
- 代理在解决问题后自动检测到该问题值得记录(例如:耗时超过一定时间、涉及架构关键决策、或者该信息有助于代码审查)。
输出格式
每个知识文档应遵循以下模板:
# [问题标题]
**日期**:YYYY-MM-DD
**作者**:AI 代理 / 用户
**涉及模块**:[相关文件名或模块名]
## 问题描述
[清晰的背景和症状描述]
## 分析过程
[一步一步的排查过程,关键日志、错误信息等]
## 解决方案
[最终修复或实现方式]
教训
[从本轮中学到的一般性原则、模式或后续建议]
## 使用指南
1. **确认问题值得记录**:在解决一个复杂问题后,评估其是否具有记录价值。
2. **创建或更新文档**:按照上面的模板撰写知识文档,或向 CONCEPTS.md 添加新的概念条目。
3. **保持简洁**:文档应聚焦于关键信息,避免冗余。
4. **引用相关文件**:如果解决方案引用了代码中的特定文件或函数,请注明。
## 示例
假设团队解决了“macOS 下 USB 设备无法自动挂载”的问题,可以创建 `usb-automount-macos.md`:
```markdown
# macOS USB 自动挂载问题
**日期**:2025-03-15
**涉及模块**:system/usb-manager
## 问题描述
在 macOS 15.2 上,插入 USB 驱动器后,设备不会自动挂载到 `/Volumes`。
## 解决方案
在系统偏好设置中启用“自动挂载新磁盘”。
同时,在 CONCEPTS.md 中添加条目:
- **自动挂载**:当操作系统检测到新存储设备时,自动将其挂载到文件系统的过程。在 macOS 上可通过`系统偏好设置 > 磁盘`进行配置。