Skip to content

Instantly share code, notes, and snippets.

@yujingz
Created September 2, 2025 06:50
Show Gist options
  • Save yujingz/03b3ea574c6d23255fc002b269b6082c to your computer and use it in GitHub Desktop.
Save yujingz/03b3ea574c6d23255fc002b269b6082c to your computer and use it in GitHub Desktop.
AGENTS.md for 整理 Obsidian Vault
## 使用说明
你需要对当前知识库(Obsidian Vault)的结构和笔记进行分析,并提出优化方案。
如果我认可这些建议,就立刻实施,不需要复杂的时间阶段划分。
在实施前,**务必先保证知识库已启用 Git 管理**(如果没有就 `git init`)。
每次实施前进行 commit,推荐使用自动生成的时间戳作为 tag,例如:
```
git add .
git commit -m "整理前快照 $(date +%Y-%m-%d_%H-%M-%S)"
```
------
## 阶段一:分析 `<analysis>`
**当前组织情况评估**
- 识别目前的组织方式(文件夹、标签、双链,或组合)
- 观察命名习惯的模式
- 评估文件夹层级(建议 ≤3 层)
- 找出可能的信息孤岛、重复内容
- 检查孤立笔记或失效链接
**内容类型分类**
- 分类笔记类型(参考资料、项目记录、个人日志等)
- 识别常见主题或话题
- 记录平均长度与复杂度
- 判断是否符合“原子笔记”原则
**使用模式识别**
- 分析笔记之间的连接方式
- 评估目前的链接策略
- 确定主要使用场景(学习研究、项目管理、知识积累等)
------
## 阶段二:改进建议 `<recommendations>`
**组织结构**
- 建议采用“根目录即小知识库,子目录不超过三层”的结构
- 对于暂时无处安放的内容,统一放入 **Inbox** 文件夹,作为待整理入口
- 对于跨主题的内容,推荐用 **MOC 笔记** 进行组织
**笔记架构**
- 推荐笔记类型:原子笔记、MOC 笔记、索引笔记、日记型笔记
- 提供可复用模板
**元数据与标签体系**
- 使用 YAML frontmatter(例如:`type`, `status`, `topic`, `source`, `created`, `updated`)
- 分层标签体系:#type/article, #status/draft, #topic/robotics 等
**链接策略**
- 建立双链命名约定
- 明确何时用链接 vs 何时用标签
- 当某主题相关笔记 ≥5 条时,建立 MOC
**检索优化**
- 推荐命名规范(日期、主题、缩写统一)
- Dataview 查询样例
- 提供常用搜索运算符
------
## 阶段三:实施 `<implementation>`
当我同意执行建议时:
1. **先 commit** 当前 vault 状态
2. **Codex CLI 执行操作**(如批量重命名、加标签、移动文件、生成 MOC)
3. **确认结果**,并再次 commit
整理动作可以反复执行,典型的四种触发方式:
1. **initial**:首次大整理
2. **inbox**:对 Inbox 中的新内容进行增量整理
3. **single**:针对指定单条笔记进行单独整理
4. **full**:全量重新整理与链接
------
## 阶段四:实际示例 `<examples>`
- **整理前后对比**
- **Inbox → 整理后文件夹实例**
- **MOC 样例结构**(带 Dataview 查询)
- **不同笔记类型模板**
- **标签层级示例**
------
## 应用原则
- **可扩展**:随着内容增长仍然有效
- **低摩擦捕捉**:快速记录,不必当场分类
- **渐进组织**:先丢进 Inbox,后续再整理
- **交叉引用**:尽量增加笔记之间的链接
- **Git 管理**:每次整理前后均 commit,保证可追溯
------
我觉得你的「magic words」机制很棒,可以直接写在这里当成操作指令:
- `codex organize initial` → 初次大整理
- `codex organize inbox` → 整理 Inbox
- `codex organize single <note>` → 整理单个 Note
- `codex organize full` → 全量重新整理
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment