笔记规范

版本: 2026-04-19 维护者: 坤坤

一、Obsidian 双链笔记管理

1.1 内部链接规范

• 使用 [[文件名]] 创建内部链接，避免使用绝对路径
• 关联知识点时使用 [[文件夹/文件名|显示名称]] 格式
• 引用外部资源时使用 [描述](URL) Markdown 链接

1.2 标签体系

• 一级标签：#领域 如 #Java #前端 #算法
• 二级标签：#领域/子类 如 #Java/Spring #前端/Vue
• 状态标签：#待补充 #已完成 #进行中

1.3 元数据（Frontmatter）

可选添加 YAML 元数据：

---
created: 2026-04-19
updated: 2026-04-19
tags: [Java, Spring]
status: 进行中
---

---

二、文件命名规范

2.1 阶段小结文件

• 格式: YYYY-MM-主题描述.md
• 示例: 2025-05-阶段小结-百日计划起步.md
• 要求: 文件名需体现时间和核心内容主题

2.2 知识点笔记文件

• 格式: 序号.知识点名称.md 或直接使用 知识点名称.md
• 示例: 01.Java集合框架.md 或 HashMap原理.md

2.3 项目实战文件

• 格式: 项目名称-模块名.md
• 示例: 黑马点评-用户模块.md

2.4 每日记录文件

• 格式: YYYY-MM-DD-每日记录.md
• 示例: 2025-07-10-每日记录.md

---

三、内容结构规范

3.1 快速总结（必填）

每个阶段小结文件必须在开头添加 100 字快速总结：

> **快速总结**：[100字以内概述核心内容、学习进度、关键认知]

3.2 知识点笔记结构

# 知识点名称

## 核心概念
[简述定义和作用]

## 关键要点
- 要点1
- 要点2

## 代码示例
[必要时的代码片段]

## 相关链接
- [[相关知识点1]]
- [[相关知识点2]]

3.3 阶段小结结构

> **快速总结**：...

# 阶段X小结

## 学习进度
[本周/本阶段完成的内容]

## 知识点回顾
[关键知识点梳理]

## 问题与反思
[遇到的困难、改进方向]

## 下阶段计划
[链接上一周笔记、规划下周任务]

---

四、归档管理

4.1 归档规则

• 不符合规范的笔记移入 Filestore 文件夹
• 归档文件保留原始命名，添加 .archived 后缀或移入子文件夹
• 归档前记录原因（内容过时、结构混乱、重复冗余等）

4.2 Filestore 结构

Filestore/
├── 已废弃笔记/
├── 待整理笔记/
└── 临时草稿/

---

五、阶段小结周期管理

5.1 记录频率

• 从 2026-04-09 起：每周记录一次阶段小结
• 时间点：每周日或周一进行复盘总结

5.2 周期链接规范

每个阶段小结必须包含：

## 链接导航
- ⬅️ 上一周：[[YYYY-MM-阶段小结-上一周]]
- ➡️ 下周计划：[[YYYY-MM-阶段小结-下周]]

## 本周每日随笔
- [[YYYY-MM-DD-每日记录]]
- ...

5.3 任务规划规范

小结末尾需列出下周任务：

## 下周任务清单
1. [ ] 任务1 - 预计时间
2. [ ] 任务2 - 预计时间
3. [ ] ...

---

六、内容质量标准

6.1 必要元素

元素	要求	适用范围
快速总结	100字以内	阶段小结
标题层级	最多4级	所有笔记
内部链接	关联相关内容	所有笔记
代码块	指明语言类型	技术笔记

6.2 避免的问题

• ❌ 标题中使用特殊符号（$、# 等）
• ❌ 文件名过长（建议不超过50字符）
• ❅ 内容空洞、只有占位符无实际内容
• ❅ 缺少结构、纯文字堆砌

6.3 推荐实践

• ✅ 使用 Callout 块高亮重要内容
• ✅ 使用表格对比分析
• ✅ 使用代码块配合语法高亮
• ✅ 定期 Review 和更新旧笔记

---

七、工具辅助

7.1 AI 辅助规范

• 使用 AI 生成的内容需标注来源
• AI 总结内容需人工审核后保留
• 推荐在快速总结中使用 AI 辅助提炼

7.2 Dataview 查询

可在阶段小结中使用 Dataview 查询相关笔记：

LIST
FROM "00.随笔记录"
WHERE created >= date(2026-04-09)
SORT created DESC

---

八、版本历史

版本	日期	更新内容
v1.0	2026-04-09	初版基础规范
v1.1	2026-04-19	补充命名规范、内容结构、快速总结要求

---

九、快速参考

文件命名模板

阶段小结: YYYY-MM-阶段小结-主题.md
每日记录: YYYY-MM-DD-每日记录.md
知识点:   序号.知识点名称.md
项目实战: 项目名-模块名.md

内容模板

> **快速总结**：...

# 标题

## 核心内容
...

## 相关链接
- [[...]]