hehaiguang1123
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
558 lines
11 KiB
Markdown
558 lines
11 KiB
Markdown
---
|
||
categories:
|
||
- "[[Documentation]]"
|
||
tags:
|
||
- documentation
|
||
- standards
|
||
- reading-notes
|
||
- clippings
|
||
created: 2026-05-23
|
||
type: standards
|
||
---
|
||
|
||
# 读书笔记优化规范
|
||
|
||
> 本规范基于 PARA + LLM Wiki 双层架构，针对读书笔记（文章摘录）的版式优化制定标准。
|
||
|
||
## 一、文件位置
|
||
|
||
### PARA 层分类
|
||
|
||
读书笔记使用 `categories: [[读书笔记]]` 标识，可存放于 PARA 层任意目录（推荐根目录或 Notes/ 目录）：
|
||
|
||
```
|
||
读躬行客之《井冈山的战略》.md
|
||
Notes/读躬行客之《井冈山的战略》.md
|
||
```
|
||
|
||
**与 Clippings 的区别**：
|
||
- **Clippings** (`categories: [[Clippings]]`) - 网页文章摘录，轻度处理
|
||
- **读书笔记** (`categories: [[读书笔记]]`) - 深度阅读理解，结构化整理，Callout 高亮，延伸关联
|
||
|
||
---
|
||
|
||
## 二、Frontmatter 规范
|
||
|
||
### 必填字段
|
||
|
||
```yaml
|
||
---
|
||
categories:
|
||
- "[[读书笔记]]" # ✅ 必须使用 wikilink 格式
|
||
tags:
|
||
- reading # ✅ 内容类型标签
|
||
- {主题标签} # ✅ 如 strategy, cognition 等
|
||
created: YYYY-MM-DD # ✅ 创建日期
|
||
---
|
||
```
|
||
|
||
### 可选字段
|
||
|
||
```yaml
|
||
---
|
||
rating: 1-5 # 评分（1-5分）
|
||
author:
|
||
- 作者名 # 文章/书籍作者
|
||
via: "" # 来源渠道（如微信读书、公众号等）
|
||
url: "https://..." # 原文链接
|
||
topics: [] # 主题列表（用于 PARA 分类）
|
||
---
|
||
```
|
||
|
||
### 标签体系
|
||
|
||
**内容类型标签**（必填）：
|
||
- `reading` - 读书笔记
|
||
- `article` - 文章摘录
|
||
- `post` - 博客文章
|
||
|
||
**主题标签**（根据内容添加）：
|
||
- 通用：`strategy`（战略）、`cognition`（认知）、`history`（历史）
|
||
- 特定：`mao-zedong`、`jinggangshan`（根据具体内容）
|
||
|
||
**标签命名规则**：
|
||
- ✅ 小写、短横线连接
|
||
- ✅ 支持中文（英文优先）
|
||
- ✅ 支持嵌套：`#personal/growth`
|
||
|
||
---
|
||
|
||
## 三、内容结构规范
|
||
|
||
### 1. 一句话总结（推荐）
|
||
|
||
在 frontmatter 之后，添加一句话总结：
|
||
|
||
```markdown
|
||
> **一句话**：战略问题是决定死活和输赢的全局性问题。制定战略的基础是实事求是调查研究的数据。坚持战略的关键是对事物本质的认知。
|
||
```
|
||
|
||
**格式**：
|
||
- 使用引用块 `>`
|
||
- 加粗 `**一句话**：` 标识
|
||
- 20-50 字精炼总结核心观点
|
||
|
||
---
|
||
|
||
### 2. 来源信息
|
||
|
||
```markdown
|
||
---
|
||
|
||
来源：[文章标题](https://example.com)
|
||
```
|
||
|
||
**格式**：
|
||
- 使用分隔线 `---`
|
||
- 明确标注来源类型（文章、书籍、视频等）
|
||
- 提供可点击链接
|
||
|
||
---
|
||
|
||
### 3. 正文标题
|
||
|
||
```markdown
|
||
# {文章/书籍标题}
|
||
|
||
> 基于对话内容整理
|
||
```
|
||
|
||
**格式**：
|
||
- 一级标题 `#` 为笔记主标题
|
||
- 添加来源说明（如"基于对话内容整理"）
|
||
|
||
---
|
||
|
||
### 4. 章节标题规范
|
||
|
||
#### ❌ 不推荐：带序号的章节
|
||
|
||
```markdown
|
||
## 一、什么叫战略？
|
||
## 二、作者的逻辑链（示意图）
|
||
```
|
||
|
||
#### ✅ 推荐：简洁的章节名
|
||
|
||
```markdown
|
||
## 战略的定义
|
||
## 逻辑链
|
||
## 教员的战略规划
|
||
```
|
||
|
||
**原则**：
|
||
- 使用二级标题 `##` 为主要章节
|
||
- 章节名简洁、描述性强
|
||
- 避免冗余前缀（如"一、"、"二、"）
|
||
|
||
---
|
||
|
||
### 5. Callout 高亮规范
|
||
|
||
Callout 用于高亮关键观点，增强可读性。
|
||
|
||
#### 常用 Callout 类型
|
||
|
||
| 类型 | 用途 | 示例场景 |
|
||
|------|------|----------|
|
||
| `info` | 一般信息 | 核心观点、关键问题 |
|
||
| `tip` | 建议/技巧 | 实践建议、方法提示 |
|
||
| `warning` | 警告 | 风险提示、错误警示 |
|
||
| `danger` | 危险 | 严重后果、必须避免 |
|
||
| `important` | 重要信息 | 基本条件、核心原则 |
|
||
| `success` | 成功/积极 | 成功案例、正能量 |
|
||
| `quote` | 引用 | 金句、核心论断 |
|
||
| `example` | 示例 | 实际案例、应用场景 |
|
||
|
||
#### Callout 使用规则
|
||
|
||
**1. 高亮核心观点**
|
||
|
||
```markdown
|
||
> [!info] 战略的核心问题
|
||
>
|
||
> 战略问题通常只跟两个问题有关：
|
||
> - 什么问题解决不掉，你会死？
|
||
> - 什么问题解决不掉，你无法赢？
|
||
```
|
||
|
||
**2. 强调警示信息**
|
||
|
||
```markdown
|
||
> [!danger] 战略危机
|
||
>
|
||
> **这两个短板不解决，井冈山根据地没有发展前途可言。**
|
||
```
|
||
|
||
**3. 引用金句**
|
||
|
||
```markdown
|
||
> [!quote] 战略的本质差异
|
||
>
|
||
> 人生有无战略区别之大，犹如草履虫和人之间的区别。
|
||
```
|
||
|
||
**4. 提供实践建议**
|
||
|
||
```markdown
|
||
> [!tip] 三位一体
|
||
>
|
||
> 三者是一个整体，缺一不可。
|
||
```
|
||
|
||
**5. 标注核心原则**
|
||
|
||
```markdown
|
||
> [!important] 革命胜利的基本条件
|
||
>
|
||
> 革命力量必须大于反革命力量。
|
||
>
|
||
> 不是一时一地的大于，而是系统性的大于。
|
||
```
|
||
|
||
**Callout 标题规范**：
|
||
- ✅ 标题简洁、有描述性（不超过 10 字）
|
||
- ✅ 第一句可以加粗关键信息
|
||
- ✅ 支持折叠：`> [!tip]-collapsed`
|
||
|
||
---
|
||
|
||
### 6. 引用块使用
|
||
|
||
**一般引用**（非 Callout）：
|
||
|
||
```markdown
|
||
> 教员不是上了井冈山才有了本事，这些文章是他此前的思考跟实际情况结合的产物。
|
||
```
|
||
|
||
**用于**：
|
||
- 普通内容引用
|
||
- 非关键观点的强调
|
||
- 原文摘录
|
||
|
||
---
|
||
|
||
### 7. 列表格式规范
|
||
|
||
#### 缩进规则
|
||
|
||
```markdown
|
||
- 一级列表
|
||
- 二级列表（3 空格缩进）
|
||
- 三级列表（6 空格缩进）
|
||
```
|
||
|
||
**❌ 避免**：
|
||
```markdown
|
||
- 一级列表
|
||
- 二级列表（4 空格，过于宽）
|
||
```
|
||
|
||
#### 有序列表
|
||
|
||
```markdown
|
||
1. **标题**
|
||
- 要点 1
|
||
- 要点 2
|
||
```
|
||
|
||
---
|
||
|
||
### 8. 表格规范
|
||
|
||
```markdown
|
||
| 维度 | 苏联 | 中国 |
|
||
|------|------|------|
|
||
| 政权结构 | 沙俄中央集权 | 军阀割据 |
|
||
| 革命路径 | 关键节点爆发 | 长期积累 |
|
||
```
|
||
|
||
**规范**：
|
||
- 使用对齐线 `|` 确保列对齐
|
||
- 表头使用 `|` 包裹
|
||
- 列宽适中，避免过宽
|
||
|
||
---
|
||
|
||
### 9. 总结章节
|
||
|
||
在笔记末尾添加总结章节：
|
||
|
||
```markdown
|
||
## 总结
|
||
|
||
| 核心论点 | 关键表述 |
|
||
|----------|----------|
|
||
| 战略的定义 | 全局性、决定生死/胜负的问题 |
|
||
| 战略的制定 | 建立在全面调研、实事求是的基础上 |
|
||
| 战略的坚持 | 需要对事物本质的认知 |
|
||
| 个人启发 | 从小事全局意识开始，长期积累认知，逐步形成战略头脑 |
|
||
```
|
||
|
||
---
|
||
|
||
### 10. 延伸阅读（推荐）
|
||
|
||
添加相关笔记的 wikilink：
|
||
|
||
```markdown
|
||
## 延伸阅读
|
||
|
||
### 相关主题
|
||
|
||
- [[实事求是]] - 实事求是的哲学基础和方法论
|
||
- [[调查研究]] - 调查研究的意义和实践方法
|
||
- [[唯物辩证法]] - 对事物本质的认知工具
|
||
|
||
### 阅读建议
|
||
|
||
这篇笔记适合反复阅读，建议配合以下实践：
|
||
1. 在实际工作/学习中应用"两个战略问题"框架
|
||
2. 建立自己的"数字XXX"调研体系
|
||
3. 从小事开始培养全局意识
|
||
```
|
||
|
||
---
|
||
|
||
## 四、内容质量标准
|
||
|
||
### 1. 结构清晰
|
||
|
||
- ✅ 有明确的章节划分
|
||
- ✅ 逻辑层次清晰（一级到三级标题）
|
||
- ✅ 重要内容使用 Callout 高亮
|
||
|
||
### 2. 信息完整
|
||
|
||
- ✅ Frontmatter 必填字段完整
|
||
- ✅ 来源信息明确
|
||
- ✅ 关键观点不遗漏
|
||
|
||
### 3. 可读性强
|
||
|
||
- ✅ Callout 高亮关键观点
|
||
- ✅ 使用列表、表格组织信息
|
||
- ✅ 章节标题简洁有力
|
||
|
||
### 4. 可关联性
|
||
|
||
- ✅ 添加延伸阅读 wikilink
|
||
- ✅ 使用嵌套标签（如 `#personal/growth`）
|
||
- ✅ 关联相关概念笔记
|
||
|
||
---
|
||
|
||
## 五、常见错误及修正
|
||
|
||
### ❌ 错误 1：Frontmatter 缺失 categories
|
||
|
||
```yaml
|
||
---
|
||
tags:
|
||
- note
|
||
- journal
|
||
created: 2026-05-22
|
||
---
|
||
```
|
||
|
||
**修正**：
|
||
|
||
```yaml
|
||
---
|
||
categories:
|
||
- "[[读书笔记]]" # ✅ 添加
|
||
tags:
|
||
- reading
|
||
created: 2026-05-22
|
||
---
|
||
```
|
||
|
||
---
|
||
|
||
### ❌ 错误 2：内容嵌套在代码块中
|
||
|
||
```markdown
|
||
---
|
||
---
|
||
|
||
```markdown
|
||
# 井冈山的战略逻辑
|
||
|
||
内容...
|
||
```
|
||
```
|
||
|
||
**修正**：
|
||
|
||
```markdown
|
||
---
|
||
---
|
||
|
||
# 井冈山的战略逻辑
|
||
|
||
内容... # ✅ 直接写入，不包裹代码块
|
||
```
|
||
|
||
---
|
||
|
||
### ❌ 错误 3：标签使用大写或空格
|
||
|
||
```yaml
|
||
tags:
|
||
- Strategy
|
||
- Mao Zedong
|
||
- personal growth
|
||
```
|
||
|
||
**修正**：
|
||
|
||
```yaml
|
||
tags:
|
||
- strategy # ✅ 小写
|
||
- mao-zedong # ✅ 短横线连接
|
||
- personal/growth
|
||
```
|
||
|
||
---
|
||
|
||
### ❌ 错误 4：章节标题冗余
|
||
|
||
```markdown
|
||
## 一、什么叫战略？
|
||
## 二、作者的逻辑链（示意图）
|
||
## 三、教员的战略规划
|
||
```
|
||
|
||
**修正**：
|
||
|
||
```markdown
|
||
## 战略的定义
|
||
## 逻辑链
|
||
## 教员的战略规划
|
||
```
|
||
|
||
---
|
||
|
||
### ❌ 错误 5：列表缩进不规范
|
||
|
||
```markdown
|
||
- 一级列表
|
||
- 二级列表（4 空格）
|
||
- 三级列表（8 空格）
|
||
```
|
||
|
||
**修正**：
|
||
|
||
```markdown
|
||
- 一级列表
|
||
- 二级列表（3 空格）
|
||
- 三级列表（6 空格）
|
||
```
|
||
|
||
---
|
||
|
||
## 六、工作流建议
|
||
|
||
### 1. 创建读书笔记
|
||
|
||
**步骤**：
|
||
1. 使用 `Clipping Template.md` 创建新笔记
|
||
2. 填写 frontmatter 必填字段
|
||
3. 编写一句话总结
|
||
4. 整理正文内容（按章节结构）
|
||
5. 添加 Callout 高亮关键观点
|
||
6. 添加延伸阅读 wikilink
|
||
|
||
**工具**：
|
||
- Obsidian Web Clipper - 自动抓取网页内容
|
||
- defuddle CLI - 清除网页杂讯
|
||
|
||
---
|
||
|
||
### 2. 定期优化
|
||
|
||
**每周任务**：
|
||
- [ ] 检查本周创建的读书笔记
|
||
- [ ] 添加缺失的 Callout
|
||
- [ ] 优化章节标题
|
||
- [ ] 添加相关 wikilink
|
||
- [ ] 更新标签
|
||
|
||
**每月任务**：
|
||
- [ ] 批量检查 frontmatter 完整性
|
||
- [ ] 统一标签命名规范
|
||
- [ ] 创建缺失的概念笔记
|
||
|
||
---
|
||
|
||
### 3. 质量检查清单
|
||
|
||
创建/优化读书笔记时，逐项检查：
|
||
|
||
**Frontmatter**：
|
||
- [ ] `categories: [[读书笔记]]` 存在
|
||
- [ ] `tags` 包含 `reading`
|
||
- [ ] `created` 日期正确
|
||
- [ ] `author`、`url` 等可选字段填写
|
||
|
||
**内容结构**：
|
||
- [ ] 有一句话总结（推荐）
|
||
- [ ] 来源信息明确
|
||
- [ ] 章节标题简洁（无序号前缀）
|
||
- [ ] 使用 Callout 高亮关键观点（3-8 个）
|
||
- [ ] 列表缩进规范（3/6 空格）
|
||
- [ ] 有总结章节
|
||
|
||
**可关联性**：
|
||
- [ ] 添加延伸阅读章节
|
||
- [ ] 包含 3+ 个 wikilink
|
||
- [ ] 使用嵌套标签
|
||
|
||
---
|
||
|
||
## 七、模板参考
|
||
|
||
### 完整示例
|
||
|
||
参见：`Templates/读书笔记模板.md` 或 `Clipping Template.md`（优化版）
|
||
|
||
**快速使用**：
|
||
1. 复制模板
|
||
2. 填写 frontmatter
|
||
3. 粘贴内容并按结构整理
|
||
4. 添加 Callout 和 wikilink
|
||
|
||
---
|
||
|
||
## 八、相关资源
|
||
|
||
### 内部文档
|
||
|
||
- [[AGENTS.md]] - PARA + LLM Wiki 架构规范
|
||
- [[Categories/读书笔记]] - 读书笔记类别索引
|
||
- [[Wiki Page Template]] - Wiki 页面模板
|
||
|
||
### Obsidian 技能
|
||
|
||
- `obsidian-markdown` - Obsidian 语法支持
|
||
- `obsidian-cli` - 命令行工具
|
||
- `defuddle` - 网页内容清理
|
||
|
||
### 外部参考
|
||
|
||
- [Obsidian Flavored Markdown](https://help.obsidian.md/obsidian-flavored-markdown)
|
||
- [Callouts - Obsidian Help](https://help.obsidian.md/callouts)
|
||
- [Internal Links - Obsidian Help](https://help.obsidian.md/links)
|
||
|
||
---
|
||
|
||
## 更新日志
|
||
|
||
| 日期 | 版本 | 更新内容 |
|
||
|------|------|----------|
|
||
| 2026-05-23 | 1.0 | 初始版本，基于"井冈山的战略"读书笔记优化制定 |
|
||
|
||
---
|
||
|
||
> 本规范为动态文档，欢迎根据实际使用反馈进行迭代优化。
|