术语库文件格式规范 v1.0
本文档规定术语库中所有 .md 文件的统一格式标准,确保一致性和可维护性。
一、Frontmatter 规范
每个术语文件必须以 YAML Frontmatter 开头:
---
tags: [分类1, 分类2, 关键词]
aliases: [英文术语, 中文别名1, 中文别名2]
difficulty: 初级|中级|高级
lessons: [L01, L02, ...]
created: YYYY-MM-DD
updated: YYYY-MM-DD
---字段说明
| 字段 | 必填 | 格式 | 说明 |
|---|---|---|---|
tags | ✅ | 数组 | 至少包含 [语法/技能/工具],最多5个标签 |
aliases | ✅ | 数组 | 英文术语名在前,中文别名在后 |
difficulty | ✅ | 字符串 | 初级 / 中级 / 高级 |
lessons | 可选 | 数组 | 关联的新概念课文编号,如 [L89, L92] |
created | ✅ | 日期 | 创建日期 YYYY-MM-DD |
updated | ✅ | 日期 | 最后更新日期 YYYY-MM-DD |
tags 规范值
# 一级分类(必选其一)
- 语法
- 技能
- 工具
# 二级分类
- 动词 / 从句 / 语气 / 句式 / 词法 / 句法 / 语篇
- 阅读 / 听力 / 写作 / 翻译 / 口语
- 参考 / 索引 / 指南
# 三级标签
- 核心概念 / 细分术语 / 易混淆点二、文件命名规范
| 类型 | 命名规则 | 示例 |
|---|---|---|
| 核心术语 | 中文术语名.md | 情态动词.md |
| 细分术语 | 保持简洁,可用英文 | must have done.md |
| 复合术语 | 用连接号分隔 | 直接引语与间接引语.md |
| 工具文件 | 功能性命名 | 术语索引.md, 语法速查表.md |
三、正文结构规范
术语文件必须按以下顺序包含以下章节:
# 术语中文名 (English Term)
## 定义
简洁明确定义,1-2句话。
## 核心要点
### 要点一
内容...
### 要点二
内容...
## 详细解析
(根据需要添加子章节)
## 常见错误
| 错误 | 正确 | 说明 |
|:-----|:-----|:-----|
| ❌ | ✅ | ... |
## 在课文中的应用
### LXX 课文标题
- 例句1
- 例句2
## 四级考点
1. 考点一
2. 考点二
## 练习与自测
### 练习题
1. 题目...
2. 题目...
### 答案与解析
<details>
<summary>点击查看答案</summary>
1. 答案...
解析...
</details>
## 关联术语
### 前置知识(先学)
- [[术语1]]
- [[术语2]]
### 平行概念(同时学)
- [[术语3]]
### 进阶学习(后学)
- [[术语4]]
---
*最后更新:YYYY-MM-DD*四、表格格式规范
标准表格模板
| 列1 | 列2 | 列3 |
|:-----|:-----|:-----|
| 内容 | 内容 | 内容 |格式要求
- 表头对齐:使用
|:---|:---|:---|左对齐(推荐) - 加粗重点:关键词用
**加粗** - 避免空行:表头和内容之间不要有空行
- 精简列宽:控制在4-5列,过宽表格考虑拆分
对比表标准格式
| 维度 | A | B |
|:-----|:--|:--|
| 特点1 | ... | ... |
| 特点2 | ... | ... |五、Obsidian 链接规范
基本链接
[[术语名]]带别名链接
[[术语名|显示文字]]链接使用场景
链接原则
- 每个术语在文件中首次出现应添加链接
- 同一文件内后续出现不再重复链接
- 表格中的术语都应链接
六、视觉标记规范
强调标记
| 标记 | 用法 | 示例 |
|---|---|---|
**粗体** | 关键词、术语 | 情态动词 |
*斜体* | 英文术语、书名 | Modal Verb |
`代码` | 语法结构、代码 | have done |
> 引用 | 例句出处、引用 | > 课文原句 |
图标使用(可选)
⭐ 核心概念 / 必学
📌 重点提示
⚠️ 常见错误
💡 学习技巧
🔗 关联知识七、代码块规范
语法示例
使用 markdown 标记:
```markdown
例句:**He** *must* have been tired.
### ASCII 图表
使用纯文本:
```markdown
时间轴图示
八、文件末尾规范
所有文件以分隔线结尾:
---
*最后更新:YYYY-MM-DD*九、质量检查清单
发布前确认:
- Frontmatter 完整且格式正确
- 标题使用
# 中文 (English)格式 - 包含”定义”章节
- 包含”在课文中的应用”章节(工具类除外)
- 包含”练习与自测”章节
- 包含”关联术语”章节
- 表格格式统一(
|:---|:---|) - 首次提及的术语已添加
[[链接]] - 文件末尾有更新日期
- 文件名符合命名规范
十、示例文件
参考模板文件:TEMPLATE.md
规范版本:v1.0
最后更新:2026-04-02