记忆
一个基于文件系统的知识管理系统,其中源代码本身就是记忆。以结构化的 Markdown 文件存储决策、模式和上下文。
何时使用
- 记录架构决策
- 记录开发过程中发现的模式
- 保存关于某个功能为何以特定方式构建的上下文
- 跟踪已知问题及解决方法
- 存储 API 文档或集成说明
何时不使用
- 临时调试笔记(改用注释)
- 任务跟踪(使用 Git Issue 或项目面板)
核心原则
- 源代码是唯一真实来源
- 将知识存储在其使用位置附近
- 使用结构化的 Markdown 保持一致性
- 保持文件焦点明确(一个文件一个主题)
存储位置
| 类型 | 位置 | 示例 |
|---|---|---|
| 技术文档 | docs/technical/ | 架构决策、模式 |
| 功能文档 | docs/features/ | 功能规格、需求 |
| API 文档 | docs/api/ | API 契约、集成说明 |
记忆操作
记住(写入)
存储新知识:
# [主题标题]
## 上下文
[为什么存在,它解决了什么问题]
## 决策
[做了什么决定以及原因]
## 细节
[技术细节、代码示例]
## 参考
- [相关文件或 URL]
---
*创建时间:[日期]*
*最后更新:[日期]*
回忆(读取)
检索知识:
- 检查
docs/目录结构 - 读取相关文件
- 跨文档搜索关键词
更新
修改现有知识:
- 读取现有文件
- 更新相关章节
- 如果改动较大,添加到演进历史中
相关技能
| 技能 | 何时链接 |
|---|---|
| feature-dev | 在开发过程中存储架构决策 |
| planning | 记录计划以备将来参考 |