kdletters
15a527d7f4
迁移项目共享记忆到 docs/project-memory，保留 .hermes 仅作为工具目录 新增 Agent 本地 RAG 索引与上下文包检索脚本 记录 RAG 依赖只安装到 .rag/runtime 并加入忽略规则 同步文档与检查脚本中的项目记忆路径
33 lines
1.4 KiB
Markdown
33 lines
1.4 KiB
Markdown
# 项目记忆目录
|
|
|
|
本目录保存可以进入 Git 的项目级长期知识，供开发者和 Agent 读取。`.hermes/` 只保留 Hermes 工具专用资源，不再作为项目知识库。
|
|
|
|
## 目录结构
|
|
|
|
```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
|
|
├─ plans/
|
|
└─ todos/
|
|
```
|
|
|
|
## 使用原则
|
|
|
|
- 开发前先读 `AGENTS.md`，再按任务读取 `docs/project-memory/shared-memory/` 和当前 `docs/` 文档。
|
|
- 长期有效的架构约定、接口变化、排障经验、开发流程和协作规则写入 `shared-memory/`。
|
|
- 阶段性计划写入 `plans/`，已确定但暂未实施的共享 TODO 写入 `todos/`。
|
|
- 如果本目录内容与代码或最新 `docs/` 冲突，以代码和最新 `docs/` 为准，并同步修正过期记忆。
|
|
- 禁止写入个人配置、API Key、Token、Cookie、会话记录、认证文件、本地私密路径、构建产物、日志、缓存和数据库 dump。
|
|
|
|
## RAG 索引
|
|
|
|
本目录是 Agent 本地 RAG 的高权重索引源。RAG 主要用于 Agent 检索上下文，不替代人工阅读入口或正式文档地图。索引脚本位于 `scripts/rag/`，本地生成的 `.rag/` 数据不提交 Git。
|