SuperAPI AI 工具集

project-memory

办公与效率

查看项目

更新于 10-16 06:39

技能介绍

用途

Project Memory 用于为项目维护“机构知识”(institutional knowledge)。它通过在 docs/project_notes/ 目录下建立结构化的记忆系统,让项目能够跨编码会话、跨不同 AI 工具记住过去的决策、问题解决方案和重要配置细节。

主要能力

1. 初始设置:创建记忆基础设施

首次在项目中调用时,创建以下结构:

docs/ └── project_notes/ ├── bugs.md # 带解决方案的 bug 日志 ├── decisions.md # 架构决策记录(ADR) ├── key_facts.md # 项目配置与常量 └── issues.md # 带工单引用的工作日志

目录命名理由:使用 docs/project_notes/ 而非 memory/,使其看起来像标准工程组织方式,而非 AI 专用工具,从而提高人类开发者的采用与维护意愿。

初始文件内容从本技能的 references/ 目录复制模板:

  • references/bugs_template.md 用于初始 bugs.md
  • references/decisions_template.md 用于初始 decisions.md
  • references/key_facts_template.md 用于初始 key_facts.md
  • references/issues_template.md 用于初始 issues.md

每个模板包含格式示例和使用提示。

2. 配置 CLAUDE.md:记忆感知行为

在项目的 CLAUDE.md 文件中添加或更新“Project Memory System”部分,包含记忆文件说明、记忆感知协议(在提出架构变更前检查 decisions.md、遇到错误时搜索 bugs.md、查找配置时检查 key_facts.md、完成工单时记录到 issues.md、用户请求更新时更新对应文件)以及记忆文件风格指南(优先使用项目符号列表而非表格、条目简洁、始终包含日期、包含 URL、手动清理旧条目)。

3. 配置 AGENTS.md:多工具支持

如果项目有 AGENTS.md 文件,添加相同的记忆协议,确保使用 Claude Code、Cursor、GitHub Copilot 或其他 AI 工具时保持一致。如果 AGENTS.md 不存在,询问用户是否要创建它。

4. 搜索记忆文件

遇到问题或做决策时,主动搜索记忆文件,例如:

搜索 bugs.md:

grep -i "connection refused" docs/project_notes/bugs.md grep "2025-01" docs/project_notes/bugs.md

搜索 decisions.md:

grep -i "database" docs/project_notes/decisions.md grep "^### ADR-" docs/project_notes/decisions.md

搜索 key_facts.md:

grep -A 5 "Database" docs/project_notes/key_facts.md grep -i "service account" docs/project_notes/key_facts.md

也可使用 Grep 工具进行更复杂的搜索,例如跨所有记忆文件搜索 oauth,或进行上下文感知搜索。

5. 更新记忆文件

当用户请求更新或记录已解决的问题时,更新对应记忆文件。技能提供了 bug 条目、决策条目、关键事实和工作日志条目的格式示例。

6. 记忆文件维护

定期清理旧条目:用户负责手动清理(无自动化);移除 6 个月以上不再相关的 bug 条目;归档 issues.md 中 3 个月以上的已完成工作;保留所有决策;项目配置变化时更新 key_facts.md。冲突解决:如果提议与 decisions.md 冲突,解释为何需要重新审视该决策;如果选择改变,更新决策条目并添加修订日期。

使用方式

在以下情况调用此技能:

  • 启动一个会随时间积累知识的新项目
  • 项目已有反复出现的 bug 或应被记录的决策
  • 用户要求“设置项目记忆”或“跟踪我们的决策”
  • 用户想要记录 bug 修复、架构决策或已完成工作
  • 遇到感觉熟悉的问题(“我们之前不是解决过这个吗?”)
  • 在提出架构变更之前(先检查现有决策)
  • 在有多开发者或多种 AI 工具(Claude Code、Cursor 等)的项目上工作

适用场景

技能提供了示例工作流:遇到熟悉的 bug 时搜索 bugs.md 并应用已知修复;提议架构变更前检查 decisions.md 避免冲突;用户请求更新记忆时添加条目;查找项目配置时检查 key_facts.md。

与其他技能的集成

project-memory 与其他技能互补:requirements-documenter(需求 -> 决策)、root-cause-debugger(bug 诊断 -> bug 日志)、code-quality-reviewer(质量问题 -> 决策)、docs-sync-editor(代码变更 -> 关键事实)。一起使用时,可考虑将更新记忆文件作为后续操作。

成功标准

成功部署的标志:docs/project_notes/ 目录存在且包含全部四个记忆文件;CLAUDE.md 包含带协议的“Project Memory System”部分;AGENTS.md 包含相同协议(如果文件存在或用户要求);记忆文件遵循模板格式和风格指南;AI 助手在提出变更前检查记忆文件;用户可以轻松请求记忆更新;记忆文件看起来像标准工程文档,而非 AI 产物。

限制

记忆文件的清理为手动操作,无自动化。key_facts_template.md 包含关于不应存储哪些内容的安全指南。具体模板内容、示例细节和完整协议文本需参考技能内的 references/ 目录文件。