SCHEMA.md 5.2 KB


tags:

  • 知识图谱
  • schema type: 规范 ---

SCHEMA.md · 页面字段与语法规范

[!note] 与 AGENTS.md 的分工 [[AGENTS]] 讲流程(ingest/query/lint 怎么做),本文件讲格式(页长什么样)。lint.py 的每条检查都对应本文件的某一条。

1. 文件名规则

规则 说明
一律中文 取直观短标题,一眼看出内容,如 肠屏障.md、三年级滑坡.md、碘酒褪色误区.md
长度 ≤ 30 字;避免冒号后挂大段解释,冒号可改成短横或用顿号
Windows 非法字符 \ / : * ? " < > \| 一律替换为全角或顿号(/ → 、、: → 、)
跨页唯一 全库文件名不得重名;重名时加限定词
例外 index.md、log.md 保留英文命名,grep 命令依赖它们

2. frontmatter 字段(YAML)

---
title: 肠屏障                        # 必填,与文件名(去 .md)一致
aliases: [肠上皮屏障, gut barrier]   # 可选,历史名/异写,便于回链
tags:                                # 必填,≥2 个
  - 知识图谱
  - 菌群机制
  - 概念
entity_type: 概念                    # 必填,见 §3
topic: 菌群机制                       # 必填,必须是五个主题之一
sources:                             # 必填,指向 raw/ 的相对路径
  - "raw/microbiome/菌群关键论断句_按知识轴.md"
created: 2026-10-03                  # 建页日期
updated: 2026-10-03                  # 最近一次实质修改
schema_version: v1                   # 必填,与本文件一致
---

[!warning] 缺任一必填字段都会被 lint 点名;sources 为空的页在 Ingest 时不算完成。

3. entity_type 实体类型

类型 什么时候建页 数量现状 示例
概念 核心机制、通路、边界清晰的想法 25 肠道菌群、肠—脑轴、肠屏障
方法 可操作的手段、技术、干预 10 益生元、益生菌、粪菌移植、16S 测序、多组学
知识轴 一批语料归集出的主线(≥15 篇支撑) 10 免疫炎症轴、干预技术轴、代谢轴
术语 跨页复用的名词/分子名 9 短链脂肪酸、胆汁酸、脂多糖、TMAO
合规红线 必须遵守的红线,独立成页不混入结论 7 禁词表、还原水经营合规红线
跨域桥 连接两个及以上主题的结论层页面 4 桥 1 · 氧化—炎症、桥 2 · 儿童双窗口期
资产盘点 规模、清单、盘点类 1 知识资产盘点
机构 主体、平台、设备厂商 1 Enagic Leveluk 设备
模型 / 论文 / 人物 / 事件 暂未启用;里程碑论文才单独建页 0 ——

[!tip] 不建页的情形:子概念 < 200 字并入父页;只在某一页出现一次的名词并入那一页;人物仅在概念页里以引用形式出现。

4. 页面六节(缺一即 lint 报错)

顺序 标题 约束
1 ## 摘要 ≤ 2 句,结论先行
2 ## 定义 边界 + 别名 + 英文原名;跨主题时点明另一侧链接
3 ## 关键论点 bullet,每条 ≤ 60 字,可独立被引用
4 ## 证据 · 来源 每条形如「出自 [[页面]];原文见 [[raw/…|原文]] §锚点」
5 ## 关联 四行结构:- 基础: - 对比: - 应用: - 同域:
6 callout 表述分层 > [!tip]+ 表述分层(学员面通俗 / 专家面精确) 下挂两个 bullet

单页中文字符数目标 < 1500,超限即合并或拆分(lint 报 oversized)。

5. Markdown 方言(Obsidian)

[[页面名]]                            # 页间互链,中文文件名即链接名
[[raw/microbiome/xxx.md|原文]] §锚点  # 指向 raw 原文文件,| 前是路径、后是显示名
> [!note] / > [!tip]+ / > [!warning] / > [!danger]   # callout,+ 可折叠
> [!abstract] 或 > [!example]- 写说明与示例
tags 写在 frontmatter,正文不用 #内联标签
| 表头 | 表头 |                    # 管道表
- bullet                             # 并列要点

6. 硬约束(lint 会点名)

  1. 禁词:A 医疗类、B 伪科学类任何页面都不许出现主张性使用;若引用违规原文,必须写明「该表述属资料原有违规内容,已列入禁词」。
  2. 证据层级:对外主张必须标层级;引用菌群侧语料时说明其为厂商科普二手转述。
  3. 跨域边界:菌群页与还原水页不得互为因果背书。
  4. 反链:每页至少 1 个入链(新页建完必须回头给已有页补链),否则 lint 报孤儿。
  5. 索引同步:新页必须在 index.md 对应主题表里出现一行,否则报 index 漂移。

7. 与 lint.py 的对应关系

lint 检查项 对应规范
orphans §6.4 每页至少 1 入链
dangling_links §5 链接目标必须存在;raw/ 前缀视为文件引用、不报错
index_drift §6.5 索引同步
sections_missing §4 六节齐全
oversized §4 单页 < 1500 字
concept_without_page §3 高频缺页概念
raw_unused §2 sources 必须指向真实 raw 文件
forbidden_hits §6.1 禁词