笔记规范 v1
这份规范用于约束本仓库的笔记整理方式,目标是:
- 保持目录语义清晰
- 减少属性重复表达
- 让人和 AI 都能稳定协作
- 让博客发布规则简单、安全、可持续
1. 总原则
- 文件夹负责表达工作区、主题域或来源,不负责表达所有语义。
- 属性只保留真正有用、不会和路径重复的字段。
Inbox是处理中转站,整理后应尽量清空。- 博客发布继续采用白名单思路,只有
public: true才允许发布。 - 论文相关优先用文件夹组织,不再用
type: paper表达。
2. 目录分工
20_Inbox/- 新输入的临时入口
- 放 AI 对话、网页摘录、临时想法、待整理内容
- 整理后应分流,不作为长期存储区
40_Project/- 具体项目的过程记录、实验记录、方案和决策
60_Area/- 长期维护的控制台、规范、原则、导航和活文档
80_Resources/- 长期知识库
- 按主题组织概念、总结、MOC、论文阅读结果
99_Archive/- 冷存档,不再主动维护但保留参考价值
3. 核心属性
正式笔记优先统一为以下字段:
title:
type:
tags:
public:
created:
updated:字段含义:
title- 笔记标题
type- 内容形态
tags- 主题标签,统一使用数组
public- 是否允许博客发布
created- 创建日期
updated- 最近一次有效更新日期
4. 字段约束
type
type 只表达内容形态,不表达目录语义,不表达阶段语义。
允许枚举:
rawaichatconceptmocnote
定义如下:
raw- 暂未整理、暂时不值得细分、或暂时难定义的内容
- 多用于
Inbox
aichat- 保留下来的 AI 对话原文,或仍明显保留对话结构的记录
concept- 定义型、原理型、知识点型笔记
- 例如:
Batch Normalization
moc- 导航页、索引页、地图页
note- 其余正式笔记的兜底类型
- 包括总结、经验、方法、论文阅读整理结果等
tags
- 一律使用
tags - 不再使用
tag - 统一写成数组
示例:
tags: [deep-learning, normalization]public
public: true才允许博客发布- 未写或
false视为不公开
日期字段
- 统一使用
created和updated - 不再继续新增这些旧写法:
creationcreation datemodificationmodification date- 用单独的
date同时承担创建和更新时间
5. 最小模板
通用正式笔记
---
title:
type: note
tags: []
public: false
created: YYYY-MM-DD
updated: YYYY-MM-DD
---概念笔记
---
title:
type: concept
tags: []
public: false
created: YYYY-MM-DD
updated: YYYY-MM-DD
---AI 对话记录
---
title:
type: aichat
tags: []
public: false
created: YYYY-MM-DD
updated: YYYY-MM-DD
---待整理原始输入
---
title:
type: raw
tags: []
public: false
created: YYYY-MM-DD
updated: YYYY-MM-DD
---MOC / 导航页
---
title:
type: moc
tags: []
public: false
created: YYYY-MM-DD
updated: YYYY-MM-DD
---6. 典型判断规则
Batch Normalization- 放在
80_Resources/Deep-Learning/ type: concept
- 放在
- 一篇论文阅读总结
- 放在
80_Resources/Paper-Reading/ type: note
- 放在
- 一篇算法专题导航
- 放在
80_Resources/... type: moc
- 放在
- 一段值得保留的 GPT / Gemini 对话
- 放在
20_Inbox/或后续归档区 type: aichat
- 放在
- 暂时说不清楚怎么分类的输入
- 先放
20_Inbox/ type: raw
- 先放
7. Inbox 分流规则
Inbox 的目标不是囤积,而是分流。
整理后的去向:
- 值得长期保留的知识
- 移到
80_Resources/
- 移到
- 属于具体项目过程
- 移到
40_Project/
- 移到
- 属于长期规则、方法、控制台
- 移到
60_Area/
- 移到
- 不再活跃但保留回查价值
- 移到
99_Archive/
- 移到
- 没有持续价值
- 直接删除
8. 命名建议
- 概念笔记
- 直接用主题名
- 例如:
Batch Normalization
- 普通总结笔记
- 直接用结论或主题名
- AI 对话 / 导入内容
- 可带日期或来源
- 例如:
2026-03-24 - xxx
- MOC
- 标题中明确体现导航性质
- 例如:
MOC-排序算法
9. 本版暂不做的事
以下内容本版暂不强制统一:
- 不引入
status - 不引入
type: paper - 不强制所有旧笔记立即迁移
- 不要求所有目录都按同一层级重构
10. 后续演进方向
v1 先解决:
- 字段混用
type语义混乱Inbox长期堆积- 博客发布与笔记整理脱节
后续如有需要,再讨论:
- 模板系统统一
- 旧笔记批量迁移
- 博客公开内容标准
- AI 对话的归档策略