本项目笔记写作规范(写笔记/题解前必读 + codex 收尾审查依据)

这是 CLAUDE.md 的细则配套:CLAUDE.md 只管路线,所有可事后检查的写作细则(格式、行数、公式写法、双链、术语扫描、通用结果外置)都在这里。codex 在 Claude 发出回答前据此审查刚写/改的 DRAFT 文件。

核心一句话:一个文件 = 一个从”要解决什么问题/讨论什么主题”到”最终结果”的完整逻辑闭环;中间用到的二级结论不污染主干,抽到别的文件去。

四条硬规则

  1. 一文一线、闭环:每个文件只讲一件事,从提出问题/主题一路讲到最终结果,自成闭环。不允许因为快到行数上限就把一条正在推进的逻辑链拦腰切到两个文件。
  2. 先判断”几条线”,再谈长度:先看内容是一条线还是多条线。多条独立线 → 各自成文;一条线天然长 → 写紧,不切断。90 行是软上限,逻辑完整优先。
  3. 通用结果外置:可复用的普适公式/定理/恒等式(二级结论)放进正文参考笔记(公式卡、工具笔记),题解只用 [[ ]] 引用、不重抄;本题特有的推导则写细到每一步。
  4. 术语纪律:不出现我笔记里没有、又没解释的名词;不重要就不用、换朴素说法,重要就另开支线解释。

正反例:HW5 题二”勒让德展开”

❌ Bad(最初写法,按行数硬切)

DRAFT/勒让德展开计算技巧/
  main.md            ← 塞"四招":决策表+招1(题1全解)+招2+招3(题2/3/4的化简);
                        写到一半太长,就把"招4 + 各题真正的积分"甩给下一个文件
  积分降阶与示范.md  ← ∫₀¹Pₙ 恒等式 + |x|展开 + x|x|展开

坏在哪:

  • 一个”主题”硬塞四条线(四个小题各是一条线)。
  • 在逻辑中途按行数切:main.md 把题2/3/4 起了头就没收尾,真正的计算被推到另一文件 → 一条线裂成两半,没有闭环
  • 通用结论 埋在 DRAFT 演示文件里,没沉淀成可复用的正文工具。
  • main.md 读不到任何一个完整结果;读 积分降阶 像从半截开始。

✅ Good(整理后,按逻辑分线)

正文(通用结果,可反复引用):
  Legendre Polynomials.md   ← 公式卡,含 ∫₀¹Pₙ 的闭式
  例题-半区间勒让德积分.md  ← ∫₀¹ PₖPₗ 公式

DRAFT/勒让德展开计算技巧/(每个文件一条闭环线):
  main.md            ← 9 行纯索引:共同思路一句话 + 链到下面四条线
  题1-多项式直接拆.md ← 题(1) 从头到尾,零积分
  题2-奇延拓平方.md   ← 题(2) 从设展开到闭式 Cₖ,本题代数写细
  题3-4-绝对值型.md   ← 拆 P₁+|x|,|x|展开到结果,(3)(4) 回代

好在哪:

  • 每个题解文件都是闭环:开头点明要展开哪个 ,结尾给出系数闭式 + 核对。
  • 通用结论 进正文,题解里只 [[ ]] 引用,主干干净。
  • main.md 退化成索引,不讲内容、不会被截断。

格式约定细则

  • 语言:默认中文。
  • 公式:行内 $...$,独立 $$...$$(Obsidian 标准)。
  • 分数用 \dfrac:分数不在指数上时一律 \dfrac(更大更清晰);只有出现在指数位置上的分数才用 \frac / ^{}
  • 关键名词附英文:少数关键术语在括号里给英文,如”本征值 (eigenvalue)“。只在第一次出现或确有必要时给,不要频繁。
  • 笔记互链:引用其他笔记用双链 [[笔记名]]
  • 表格里数学不用裸竖线 |:如限制符 ,Markdown 会把裸 | 当列分隔符、整张表错位。一律用 \vert(或 \mid),写成 $u\,\vert_{x=0}$
  • 通用结果与本题推导分家:可复用的普适结果(公式/定理/恒等式)抽成单独的公式卡 / 工具笔记,题解用 [[ ]] 引用、不重抄;本题特有推导写细到每一步,不省略关键代数。
    • “外置”= 外置出题解文件、自成一卡;卡片本身仍写在 DRAFT/(AI 生成的讲解一律在 DRAFT)。不要把卡片搬进 数理方法/ 等正文目录——那是用户自己整理的空间。审查时勿据此误报。
  • 单文件 ≤ 90 行(软上限):在”逻辑完整优先”前提下尽量不超过 90 行;但绝不为凑行数把一条逻辑链拦腰切断(见上面四条硬规则)。

收尾前自检清单(codex 逐条核对)

逻辑:

  • 这个文件是不是”一条线、有闭环”?开头有问题、结尾有结果?
  • 有没有为了凑行数把逻辑切断?
  • 用到的通用结论是否已外置、用 [[ ]] 引用?本题特有推导是否写细?
  • 有没有甩出我不懂又没解释的术语?(逐词回扫,拿不准就 Grep 仓库,排除 DRAFT/Clippings/;搜不到 → 换朴素说法或另开支线解释)

格式:

  • 公式 $ $ / $$ $$;非指数位分数用 \dfrac
  • 表格单元格里没有裸 |(都换成 \vert / \mid)?
  • 笔记互链用了 [[ ]]?关键名词首现附了英文(且不过频)?
  • 单文件是否 ≤ 90 行(或虽超但确属一条不可切断的线)?