# 项目记忆目录

本目录只保存可以通过 Git 共享、并且对当前开发仍有效的项目知识。`.codex/` 只放 Codex 工具资源，不作为项目知识库。

## 当前结构

```text
docs/project-memory/
├─ README.md
├─ shared-memory/
│  ├─ project-overview.md
│  ├─ team-conventions.md
│  ├─ development-workflow.md
│  ├─ document-map.md
│  ├─ decision-log.md
│  ├─ pitfalls.md
│  ├─ handoff-template.md
│  └─ 【模板】规范驱动开发主规范与里程碑模板-2026-09-12.md
├─ plans/   # 仅限正在执行的短期计划
└─ todos/   # 仅限仍开放且有退出条件的事项
```

## 使用原则

- 开发前先读 `AGENTS.md`；复杂任务再读 Agent 执行准则、共享记忆和任务对应的当前专题文档。
- 稳定架构、接口、流程和排障边界写入 `shared-memory/`；同一事实只保留一个当前口径，细节放在权威专题文档。
- `plans/` 只保存正在执行、具有明确剩余项和验收门禁的计划；完成或作废后立即删除，稳定结论融合进当前专题或共享记忆。
- `todos/` 只保存真实开放、有人接手即可执行的事项；每项应写明状态、下一决策点和关闭条件。已退役对象不保留未来 TODO。
- 分支、提交、测试轮次和阶段流水账不进入长期记忆；需要追溯时使用 Git 历史。
- `decision-log.md` 与 `pitfalls.md` 可以直接修改、合并和删除旧条目：被覆盖的决定、退役对象专属说明和重复记录不继续保留；仍有效的风险、兼容约束和未完成事项应保留或融合到当前专题。
- 自动验证检查实际代码、配置和行为，不要求决策记录或踩坑记录包含固定措辞，也不强制把同一规则复制到多个记忆文件。
- 若本目录与代码或最新 `docs/` 冲突，以代码和最新专题为准，并在同次变更中修正记忆。
- 禁止写入个人配置、API Key、Token、Cookie、会话记录、认证文件、本地私密路径、构建产物、日志、缓存和数据库 dump。

## 决策记录格式

以下格式按需使用，简单决策不必凑齐所有字段。

```md
## YYYY-MM-DD 决策标题

- 背景：为什么需要这个决策
- 决策：最终决定是什么
- 影响范围：涉及哪些模块/文档/流程
- 验证方式：如何确认决策仍有效
- 关联文档：相关 PRD、技术文档、提交或 Issue
```

## RAG 索引

本目录是本地 RAG 的高权重索引源，但检索结果只作为候选上下文。索引脚本位于 `scripts/rag/`；运行时依赖和 `.rag/` 数据默认不安装、不提交，启用前需先征得用户确认。