跳至主要內容

构建原则

2025/6/11

本文描述内容层级的构建原则和划分方法

构建原则

充分利用 Obsidian 的特色语法, 包括但不限于:

  • 使用双链语法, 组织目录与相关内容, 构建一个数学知识的网络化结构.
  • 利用 Callout 语法, 为重点内容创建简洁美观的卡片式词条.
  • 通过块引用语法, 将原子化的内容引用到更高层次的文章中, 以实现高效的知识整合与关联.

根据以上原则, 我构建了如下内容规范

文件层级

本仓库中的所有正文md文件内容类型按等级划分为三种:

下表中为简要说明, 详细说明请转到每个子标题

层级文件名示例作用描述命名
目录--微积分--.md用于组织文档动态目录+章节导语按目录命名规则命名
文档导数应用.md用于探讨各个主题结构化知识体系+逻辑推导, 可以引用若干词条.直接用主题命名，无前后缀
词条泰勒公式.md表示基础概念或公式原子化概念；使用一段话概括. 不允许使用标题, 可以使用Callouts卡片引用直接用概念命名，无前后缀

目录

目录以树状结构组织. 包含章节列表的文件, 有时还会包含一些简要说明

1. 目录文件命名规则

在文件名前后加若干个连字符 - , 连字符的数量代表目录层级, 如:

  • 一级目录：-高等数学- -初等数学-
  • 二级目录：--微积分-- --概率论--
  • 三级目录：---极限与连续--- ---导数与微分---

这样做的好处:

  1. 保证在任何操作系统下, 目录文件总是排序在最前面.
  2. 可以使用dataview语法, 按目录等级进行查询

考虑到有的人不喜欢这种命名规则, 为了不影响网页版部署的效果, 可自行做名称处理. 本仓库的GitHub Page部署页面已做处理.

2. 目录模板

---
tags: [数学目录]
dlink: [[上级目录]]
---

> [!NOTE] 章节导语
> 简要说明本章节知识体系（≤200字）

## 动态目录
```dataview
LIST FROM "当前路径"

文档

1. 结构化写作指南

标题层级使用场景内容要求
无标题基础概念词条直接阐述核心定义
##复合型文档组织知识体系结构
###细分知识模块定理证明/应用案例
> [!NOTE]重点内容强调定义/定理/警告等特殊内容
  • 可以引用词条：![[泰勒公式]]

2. 头部的 YAML front-matter 规范

属性类型是列表的YAML配置项可以使用数组形式, 也可以使用列表形式, 推荐格式化为列表形式

tags: 
  - 数学       # 本库的默认标签, 更细致的分类工作尚未进行
  - 公式       # 如果涉及公式则添加此tag
  - 例题       # 如果是例题的文档则添加此tag
  - AI        # LLM 生成内容须额外添加此tag
dlink:        # 所属最近一层目录, 以及相关概念
  - "[[上级目录]]"
  - "[[相关概念]]"
aliases:      # 别名,简写,英文或日文名
  - 简称
  - 英文名称
  - 日文名称
chapter: 3    # 章节序号, 参考教材设置
urlink:       # 外部引用, 如 Wikipedia 链接
  - 维基百科链接
  - 教材页码
author:
  - 开发者A    # 多作者按贡献自定顺序
  - GPT-4     # 可以写LLM
datetime: 2024-05-20  # 创建日期, 也可填修改时间,不区分,不强求.为了简便考虑和edittime共用datetime属性
edittime: 2025-01-01  # 修改日期, 暂时没有计划使用

以下是一个符合规范的yaml示例:

---
tags: [数学]
dlink: 
  - [[不定积分]]
aliases: [Integration Table]
chapter: 5
urlink: [https://en.wikipedia.org/wiki/Integral_table]
author: [张三, GPT]
datetime: 2024-11-30
---

3. 标题结构

一级标题留空.
仅允许使用以下二级标题（可根据内容选择）:
- 简介: 引用相关词条, 或直接使用文档名作为一级标题.
- 定义: 明确概念和公式, 可引用相关词条.
- 推导: 展示逻辑推导过程
- 性质: 列出与其他概念的关联或理论性质
- 示例: 计算示例, 或者概念举例
- 推论: 重要的推论可以从性质中独立出来, 由主概念推导出的结论
- 应用: 在实际问题中的具体应用, 或者在其他概念中的应用

一个简单结构示例：简介 → 定义 → 性质 → 示例

词条

词条是原子化的内容, 概念源自Zettelkasten卡片盒笔记法:

  • 概念以最小粒度的词条呈现, 每个词条仅包含一个核心概念或公式.
  • 原子化的词条应确保具备独立性, 不依赖于上下文信息进行理解.
  • 原子化笔记由于其独立性, 可以被灵活地组合和引用, 从而提高知识的复用率.
  • 可以用 Callout 写核心定义
  • 禁止任何d等级标题

下面是一个词条的例子

> [!NOTE] 泰勒公式
> $$f(x) = \sum_{k=0}^n \frac{f^{(k)}(a)}{k!}(x-a)^k + R_n(x)$$

引用方法

当需要整合多个词条内容时, 在文档中使用引用语法:

![[向量]]
链接到当前文件 2