# aicoding-memory-bank

**Repository Path**: cd20/aicoding-memory-bank

## Basic Information

- **Project Name**: aicoding-memory-bank
- **Description**: 使用 Claude code 类似的 think tools 机制实现记忆功能。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-08-26
- **Last Updated**: 2025-09-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Memory Bank System

## 系统简介

Memory Bank 是一个为软件开发过程的不同阶段和不同活动提供一套专有 Mode 的结构化工作流方法。

它可以在不同阶段与活动中，自动保持上下文信息（也就是 Memory Bank 的命名由来），可以大大节约开发人员与 LLM 的交互时间。让开发人员把精力放在关键的上下文说明中，而不是一遍一遍地与 LLM 澄清和对齐当前的状态与进度。

它使用分层规则加载架构，只为每个阶段加载所需的规则，优化令牌使用并提供量身定制的指导。

本系统的规则文件以 `.mdc` 为后缀，可以直接放入 Cursor 的规则目录中。但只要根据其它 AI Coding 工具的要求，修改本系统的规则文件的后缀或应该存放的目录所在位置，即可用于对应的 AI Coding 工具上。

```mermaid
graph TD
    Main["Memory Bank System"] --> Modes["Custom Modes"]
    Main --> Rules["Hierarchical Rule Loading"]
    Main --> Visual["Visual Process Maps"]

    Modes --> PRE["PRE: Initialization"]
    Modes --> PLAN["PLAN: Task Planning"]
    Modes --> CREATIVE["CREATIVE: Design"]
    Modes --> IMPLEMENT["IMPLEMENT: Building"]
    Modes --> REFLECT["REFLECT: Review"]
    Modes --> ARCHIVE["ARCHIVE: Documentation"]

    style Main fill:#4da6ff,stroke:#0066cc,color:white
    style Modes fill:#f8d486,stroke:#e8b84d,color:black
    style Rules fill:#80ffaa,stroke:#4dbb5f,color:black
    style Visual fill:#d9b3ff,stroke:#b366ff,color:black
```

## 关于 Memory Bank 的设计思路

### 令牌架构

-   **分层规则加载**: 初始只加载基本规则，使用专门的延迟加载
-   **渐进式文档**: 实现随任务复杂度扩展的简洁模板
-   **优化的 Mode 转换**: 在 Mode 之间高效保留关键上下文
-   **级别特定工作流程**: 根据任务复杂度调整文档要求

### 超越基本自定义 Mode

虽然 Cursor 的文档将自定义 Mode 描述为主要独立的配置，具有基本提示和工具选择，但 Memory Bank 显著扩展了这个概念：

-   **基于图的 Mode 集成**: Mode 是开发工作流程中相互连接的节点，而不是孤立的工具
-   **工作流程进展**: Mode 设计为按逻辑顺序从一个 Mode 转换到另一个 Mode (PRE → PLAN → CREATIVE → IMPLEMENT → REFLECT → ARCHIVE)
-   **共享上下文**: 通过 Memory Bank 文件在 Mode 转换之间保持持久状态
-   **自适应行为**: 每个 Mode 根据项目复杂度调整其建议
-   **内置 QA 功能**: QA 功能可以从任何 Mode 调用以进行技术验证

这种方法将自定义 Mode 从简单的 AI 个性转变为协调开发系统的组件，专门的阶段协同工作。

### CREATIVE Mode 和 Claude 的"Think"工具

Memory Bank 中的 CREATIVE Mode 在概念上基于 Anthropic 的 Claude "Think"工具方法，如他们在[工程博客](https://www.anthropic.com/engineering/claude-think-tool)中所述。已实现了以下特点：

-   **分层规则加载**: 只加载基本规则，使用专门的延迟加载
-   **渐进式文档**: 随任务复杂度扩展的简洁模板
-   **统一上下文传输**: Mode 之间的高效上下文保留
-   ** Mode 特定可视化地图**: 每个开发阶段的清晰可视化表示
-   **针对级别使用特定的工作流程**: 基于复杂度的适应过程 (Levels 1-4)
-   **平台感知命令**: 自动将命令适应到你的操作系统

有关 Memory Bank 如何实现这些原则的详细说明，请参阅 [CREATIVE Mode and Claude's "Think" Tool](creative_mode_think_tool.md) 文档。

## 安装说明

### 先决条件

-   **Cursor Editor**: 需要版本 0.48 或更高。
-   **自定义 Mode **: 必须在 Cursor 中启用该功能 (Settings → Features → Chat → Custom modes)。
    <img src="assets/open_custom_modes.png" alt="Opening Custom Modes Menu"/>

-   **AI 模型**: 推荐使用 Claude 4 Sonnet 或 Claude 4 Opus 以获得最佳结果，特别是对于 CREATIVE Mode 的"Think"工具方法。

### 第 1 步：获取文件

1. 将此存储库克隆到你的项目目录中：

```bash
git clone https://gitee.com/cd20/cd20-memory-bank.git
```

### 第 2 步：将提示词放入指定的规则目录中

## 配置 Cursor

1. 将 `cursor` 目录放入项目根目录
2. 将 `cursor` 目录改名为`.cursor`

## 配置通义灵码

1. 将 `cursor` 目录放入项目根目录
2. 将 `cursor` 目录下所有`.mdc` 文件改名为`.md`
3. 将 `cursor` 目录改名为`.lingma`
4. 将 `.lingma/main.md` 改名为 `project-rule.md`

### QA 功能

QA 不是一个单独的自定义 Mode ，而是一组可以从任何 Mode 调用的验证功能。当你需要执行技术验证时，可以在任何 Mode 中通过输入"QA"来调用 QA 功能。这种方法提供了在开发过程的任何点进行验证的灵活性。

## 基本用法

1. **从 PRE Mode 开始**:

    - 在 Cursor 中切换到 PRE Mode
    - 输入"PRE"启动初始化过程
    - PRE 将分析你的项目结构并确定复杂度

2. **根据工作内容的复杂度，可以遵循以下不同级别的工作流程**:
    - **Level 1 任务**: 在 PRE 后可能直接进入 IMPLEMENT
    - **Level 2 任务**: 简化工作流程 (PRE → PLAN → IMPLEMENT → REFLECT)
    - **Level 3-4 任务**: 完整工作流程 (PRE → PLAN → CREATIVE → IMPLEMENT → REFLECT → ARCHIVE)
    - **在任何时候**: 输入"QA"执行技术验证

<img src="assets/chat_pre.png" height="50"/> <img src="assets/chat_plan.png" height="50" style="display: inline-block;"/> <img src="assets/chat_implement.png" height="50" style="display: inline-block;"/> <img src="assets/chat_creative.png" height="50" style="display: inline-block;"/> <img src="assets/chat_implement.png" height="50" style="display: inline-block;"/> <img src="assets/chat_reflect.png" height="50" style="display: inline-block;"/> <img src="assets/chat_archive.png" height="50" style="display: inline-block;"/>

1. ** 可用的命令**:

```
    PRE - 初始化项目并确定复杂度
    PLAN - 创建详细的实施计划
    CREATIVE - 探索复杂组件的设计选项
    IMPLEMENT - 系统性地构建计划的组件
    REFLECT - 审查并记录经验教训
    ARCHIVE - 创建综合文档
    QA - 验证技术实施（可以从任何 Mode 调用）
```

4. **开始使用你的项目**:

成功安装 Memory Bank 后...

## 核心文件及其用途

```mermaid
graph LR
    subgraph "Memory Bank Files"
        Tasks["tasks.md<br>Source of Truth"]
        Active["activeContext.md<br>Current Focus"]
        Progress["progress.md<br>Implementation Status"]
        Creative["creative-*.md<br>Design Decisions"]
        Reflect["reflect-*.md<br>Review Documents"]
    end

    style Tasks fill:#f9d77e,stroke:#d9b95c,stroke-width:3px,color:black
    style Active fill:#a8d5ff,stroke:#88b5e0,color:black
    style Progress fill:#c5e8b7,stroke:#a5c897,color:black
    style Creative fill:#f4b8c4,stroke:#d498a4,color:black
    style Reflect fill:#b3e6cc,stroke:#66c999,color:black
```

-   **tasks.md**: 任务跟踪的中央真相来源
-   **activeContext.md**: 维护当前开发阶段的重点
-   **progress.md**: 跟踪实施状态
-   **creative-\*.md**: 在 CREATIVE Mode 期间生成的设计决策文档
-   **reflect-\*.md**: 在 REFLECT Mode 期间创建的审查文档

## 必要的补充

### CREATIVE Mode 相关

1. creative-phase-algorithm.mdc
2.

### Implement Mode 相关

可以根据实际需求，自行定制下面三个规则文件：

1. testing-strategy.mdc:
2. implementation-testing.mdc： 用于指导 AI 如何做测试
3. implementation-deployment.mdc：用于指导 AI 如何做部署

所在位置：`cursor/rules/isolation_rules/Phases/ImplementPhase`

## 故障排除

### 常见问题

1. **规则未加载**:

    - 确保 `.cursor/rules/isolation_rules/` 目录在正确的位置
    - 验证文件权限允许读取规则文件

2. **命令执行问题**:
    - 确保从正确的目录运行命令
    - 验证平台特定命令是否正确使用

## 资源

-   [Cursor Custom Modes Documentation](https://docs.cursor.com/chat/custom-modes)
-   [CREATIVE Mode and Claude's "Think" Tool](creative_mode_think_tool.md)
-   `custom_modes/` 目录中的 Mode 特定指令文件