a6f05ab2d5
- Phase 0: AGENTS.md cleanup (dedup quotes, renumber sections, merge qmd) - Phase 1: typed relations (manage-relations.py, graph-search.py, check-staleness.py, detect-conflicts.py) - Phase 2: frontmatter validator, weekly lint, knowledge promotion, git hooks - Fix .gitignore to track tools/ and .githooks/ - Fix git remote URL (remove plaintext token) - New wiki pages: 504 pages, 34 raw sources
266 lines
5.8 KiB
Markdown
266 lines
5.8 KiB
Markdown
---
|
||
categories:
|
||
- "[[LLM Wiki]]"
|
||
tags:
|
||
- wiki
|
||
- tool
|
||
- reading-notes
|
||
- standards
|
||
- clippings
|
||
- para
|
||
created: 2026-05-23
|
||
source: "[[读书笔记优化规范]]"
|
||
type: tool
|
||
aliases:
|
||
- 读书笔记规范
|
||
- Reading Notes Standard
|
||
---
|
||
|
||
# 读书笔记优化规范
|
||
|
||
> 一套基于 PARA + LLM Wiki 架构的读书笔记版式优化标准,确保笔记结构清晰、可读性强、可关联。
|
||
|
||
---
|
||
|
||
## 定义
|
||
|
||
读书笔记优化规范是为 PARA 层 `Clippings/` 目录中的读书笔记制定的版式标准,涵盖 frontmatter 规范、内容结构、Callout 使用、章节命名等方面。
|
||
|
||
**目标**:
|
||
- 提高笔记的可读性和可维护性
|
||
- 增强笔记间的关联性
|
||
- 统一 vault 内的笔记格式
|
||
|
||
---
|
||
|
||
## 核心要素
|
||
|
||
### 1. Frontmatter 规范
|
||
|
||
**必填字段**:
|
||
|
||
```yaml
|
||
---
|
||
categories:
|
||
- "[[读书笔记]]"
|
||
tags:
|
||
- reading
|
||
- {主题标签}
|
||
created: YYYY-MM-DD
|
||
---
|
||
```
|
||
|
||
**可选字段**:
|
||
|
||
```yaml
|
||
---
|
||
rating: 1-5
|
||
author:
|
||
- 作者名
|
||
via: ""
|
||
url: "{链接}"
|
||
topics: []
|
||
---
|
||
```
|
||
|
||
### 2. 内容结构规范
|
||
|
||
**标准章节顺序**:
|
||
|
||
1. 一句话总结(引用块)
|
||
2. 来源信息
|
||
3. 正文主标题
|
||
4. 章节内容(二级标题)
|
||
5. 总结表格
|
||
6. 延伸阅读
|
||
|
||
### 3. Callout 使用规范
|
||
|
||
| 类型 | 用途 | 示例场景 |
|
||
|------|------|----------|
|
||
| `info` | 一般信息 | 核心观点、关键问题 |
|
||
| `tip` | 建议/技巧 | 实践建议、方法提示 |
|
||
| `warning` | 警告 | 风险提示、错误警示 |
|
||
| `danger` | 危险 | 严重后果、必须避免 |
|
||
| `important` | 重要信息 | 基本条件、核心原则 |
|
||
| `success` | 成功/积极 | 成功案例、正能量 |
|
||
| `quote` | 引用 | 金句、核心论断 |
|
||
| `example` | 示例 | 实际案例、应用场景 |
|
||
|
||
**示例**:
|
||
|
||
```markdown
|
||
> [!info] 战略的核心问题
|
||
>
|
||
> 战略问题通常只跟两个问题有关:
|
||
> - 什么问题解决不掉,你会死?
|
||
> - 什么问题解决不掉,你无法赢?
|
||
```
|
||
|
||
### 4. 章节标题规范
|
||
|
||
**❌ 不推荐**:
|
||
|
||
```markdown
|
||
## 一、什么叫战略?
|
||
## 二、作者的逻辑链(示意图)
|
||
```
|
||
|
||
**✅ 推荐**:
|
||
|
||
```markdown
|
||
## 战略的定义
|
||
## 逻辑链
|
||
```
|
||
|
||
**原则**:
|
||
- 使用二级标题 `##` 为主要章节
|
||
- 章节名简洁、描述性强
|
||
- 避免冗余前缀
|
||
|
||
### 5. 标签体系
|
||
|
||
**分类标签**(必填):
|
||
- `clippings` - 标识为摘录类内容
|
||
|
||
**内容类型标签**(必填):
|
||
- `reading` - 读书笔记
|
||
- `article` - 文章摘录
|
||
- `post` - 博客文章
|
||
|
||
**主题标签**(根据内容添加):
|
||
- 通用:`strategy`、`cognition`、`history`
|
||
- 特定:`mao-zedong`、`jinggangshan`
|
||
|
||
**命名规则**:
|
||
- ✅ 小写、短横线连接
|
||
- ✅ 支持中文(英文优先)
|
||
- ✅ 支持嵌套:`#personal/growth`
|
||
|
||
---
|
||
|
||
## 使用流程
|
||
|
||
### 创建读书笔记
|
||
|
||
**步骤**:
|
||
|
||
1. 复制 `Templates/读书笔记模板.md`
|
||
2. 填写 frontmatter 必填字段
|
||
3. 编写一句话总结
|
||
4. 整理正文内容(按章节结构)
|
||
5. 添加 Callout 高亮关键观点(3-8 个)
|
||
6. 添加延伸阅读 wikilink
|
||
|
||
**工具**:
|
||
- Obsidian Web Clipper - 自动抓取网页内容
|
||
- defuddle CLI - 清除网页杂讯
|
||
|
||
### 定期优化
|
||
|
||
**每周任务**:
|
||
- [ ] 检查本周创建的读书笔记
|
||
- [ ] 添加缺失的 Callout
|
||
- [ ] 优化章节标题
|
||
- [ ] 添加相关 wikilink
|
||
- [ ] 更新标签
|
||
|
||
**每月任务**:
|
||
- [ ] 批量检查 frontmatter 完整性
|
||
- [ ] 统一标签命名规范
|
||
- [ ] 创建缺失的概念笔记
|
||
|
||
### 质量检查清单
|
||
|
||
**Frontmatter**:
|
||
- [ ] `categories: [[Clippings]]` 存在
|
||
- [ ] `tags` 包含 `clippings` 和 `reading`
|
||
- [ ] `created` 日期正确
|
||
- [ ] `author`、`url` 等可选字段填写
|
||
|
||
**内容结构**:
|
||
- [ ] 有一句话总结(推荐)
|
||
- [ ] 来源信息明确
|
||
- [ ] 章节标题简洁(无序号前缀)
|
||
- [ ] 使用 Callout 高亮关键观点(3-8 个)
|
||
- [ ] 列表缩进规范(3/6 空格)
|
||
- [ ] 有总结章节
|
||
|
||
**可关联性**:
|
||
- [ ] 添加延伸阅读章节
|
||
- [ ] 包含 3+ 个 wikilink
|
||
- [ ] 使用嵌套标签
|
||
|
||
---
|
||
|
||
## 实践案例
|
||
|
||
### 案例:读躬行客之《井冈山的战略》
|
||
|
||
**文件位置**:`读躬行客之《井冈山的战略》.md`
|
||
|
||
**优化成果**:
|
||
- ✅ 添加了 8 个 Callout 高亮
|
||
- ✅ 简化了章节标题(从"一、二、"改为简洁名称)
|
||
- ✅ 添加了延伸阅读章节(4 个 wikilink)
|
||
- ✅ 规范了 frontmatter 和标签
|
||
|
||
**详见**:[[读书笔记规范使用示例]]
|
||
|
||
---
|
||
|
||
## 相关工具
|
||
|
||
### Obsidian 技能
|
||
|
||
- `obsidian-markdown` - Obsidian 语法支持
|
||
- `obsidian-cli` - 命令行工具
|
||
- `defuddle` - 网页内容清理
|
||
|
||
### 模板文件
|
||
|
||
- [[Templates/读书笔记模板.md]] - 完整模板
|
||
- [[Templates/Clipping Template.md]] - Clipping 模板
|
||
|
||
### 参考文档
|
||
|
||
- [[AGENTS.md]] - PARA + LLM Wiki 架构规范
|
||
- [[PARA]] - PARA 方法论
|
||
|
||
---
|
||
|
||
## 常见问题
|
||
|
||
### Q: 为什么读书笔记要放在 Clippings 目录?
|
||
|
||
A: Clippings 是 PARA 层专门用于存放外部摘录(网页文章、书籍摘录等)的目录,符合 PARA 组织原则。
|
||
|
||
### Q: Callout 应该使用多少个?
|
||
|
||
A: 建议 3-8 个,覆盖最核心的观点和关键信息。避免过度使用导致内容分散。
|
||
|
||
### Q: 章节标题可以有三级标题吗?
|
||
|
||
A: 可以。二级标题 `##` 为主要章节,三级标题 `###` 为子章节,四级标题 `####` 用于更细分的子章节。
|
||
|
||
### Q: wikilink 指向的笔记不存在怎么办?
|
||
|
||
A: 可以先添加 wikilink(显示为红色),后续创建对应笔记时会自动关联。这是知识网络的自然生长方式。
|
||
|
||
---
|
||
|
||
## 版本历史
|
||
|
||
| 版本 | 日期 | 更新内容 |
|
||
|------|------|----------|
|
||
| 1.0 | 2026-05-23 | 初始版本,基于"井冈山的战略"读书笔记优化制定 |
|
||
|
||
---
|
||
|
||
## 来源
|
||
|
||
> **溯源规则**:所有数字/百分比/具体结论必须标注 `[raw:{文件名}:{行号}]` 格式。
|
||
|
||
- [[读书笔记优化规范]] - 完整规范文档(raw 层)
|
||
- [[读书笔记规范使用示例]] - 实际案例演示(raw 层)
|