跳转至

笔记风格

本页最后更新于 ,内容可能过时

本文件写笔记与仓库内其他 Markdown 文件的形态: 结构, 版式, 标点, 公式, 插图
用词与语气按仓库根 CLAUDE.md 的「文风」一节
本文件与 CLAUDE.md 不再有重叠, 无需判断以哪份为准

适用范围

适用于 Coursera/ 下的全部笔记, 以及仓库内其他 Markdown 文件
写某一学科时, 参考该学科已完成笔记的实际写法
两者的差异写进当轮报告, 不修改本文件

节标题层级

# 与 ## 有两种写法, 按学科选定一种, 同一批笔记内保持一致

情形 用哪个
本文件未特别指定 #
同目录已完成笔记用 ## 与同目录一致
用户当轮指定 按用户指定的层级
  • 同一篇内不混用, 同一批并行写作的笔记之间也不混用
  • 用 # 时, 节内分点写 (1) (2) (3), 再下一层写 1. 2. 3.
  • 用 ## 时, 下一层用 ###, 再下一层用正文 (1)
  • 写作前选定层级, 写入本次记录与每个子 agent 的提示词, 不交由子 agent 自行判断

结构

  • 文件开头空三行
  • 不写书名, 章名大标题, 学习目标, 导读
  • 标题上方空两行, 下方空一行
  • 标题前不写 ------, 标题渲染后自带分割线
  • 块组之间用独立一行 ------, 分割线前后各空一行
  • 块组是一个完整的知识单元, 指一个定义簇, 一个定理连同它的证明, 或一串例题
  • 块组内部按阶段用空行分段, 不插 ------
  • 定理的陈述与证明之间空一行
  • 证明内部每 2 到 6 行一段
    分段点取在引入新的量(取, 令, 设), 换到另一个对象, 得出阶段性结论, 以及最后收束处
  • 定义簇里并列的多个定义之间空一行
  • 一串例题之间空一行
  • 排版范例见 Coursera/[1]数学/(3)抽象代数 与 Coursera/[1]数学/(5)数学分析 下的笔记

断句与行文

  • 不用全角标点 。 , 、 : ; () 「」
  • 不用 ①②③ ⑴⑵⑶ ⒈⒉⒊ ㈠㈡㈢ 这类带圈或带括号的序号字符
    序号一律写成 (1) (2) 或 1. 2.
  • 逗号写成半角 ,, 后面跟一个空格
  • 冒号与括号用半角 : ( )
  • 句末不加终止符, 靠换行断开
  • 一行一个短句
  • 并列项, 条件, 结论, 结论前的说明各自成行, 该停顿的地方换行, 不合并成长句
  • 一行尽量不超过 60 个字符, 中文与 LaTeX 都按 1 个字符计
  • 长句在逗号, 以及 且 或 则 即 所以 于是 由 等处断开, 拆成多行
  • 中文与数字, 中文与行内公式之间加空格
  • 行内变量一律写入数学模式, 例如 $p$ $V$ $n$
  • 不用加粗, 斜体, callout, emoji, 强调由标题, 列表, 分隔线承担
  • 动词用最普通的: 由…组成, 表示, 决定, 换成, 生成

改前
该系统由三部分组成,分别是 A、B 和 C。

改后
该系统由三部分组成
1. A
2. B
3. C

标记约定

  • 术语写成 术语: 解释
  • 例题与推导写成 > 例1-1: ... 引用块
  • 附注, 特例用 [方括号] 标出

公式与化学式

  • 行内与独立公式都用单个 $...$, 全篇不出现 $$
  • 独立公式单独成段, 前后空行
  • 一条公式单独占一行, 不与说明文字混排
  • 推导链一行一步, 写成 $...$ 顺次排下来
  • 多步推导用 $\begin{aligned}...\end{aligned}$, & 对齐等号, 行尾 \\
  • 行内分数过小时, 用 \dfrac 或 aligned 包裹
  • 断不开的长公式(\begin{cases}, 长不等式链)保留整行, 不拆分
  • 数学模式内可以放中文, 不需要为此改写公式
  • 不要为了验证渲染去装 KaTeX 等命令行工具, 命令行版与渲染器内嵌的解析器不是同一套
  • 子 agent 看不到渲染结果, 遇到不确定的写法照原样写, 并在报告里列出待确认项
  • 化学式一律写 \ce{}, 含离子, 电子排布, 杂化, 水合物
  • \ce{} 内可以放中文, 不需要写到外面
  • 箭头写 ->, 平衡写 <=>, 条件写在箭头上 ->[高温]
  • 化学键写 -, =, #
  • 单位写 \mathrm{}, 数值与单位之间用 \
  • 状态函数上下标统一写成 \Delta_rH_\text{m}^\ominus 这一种
  • 分子结构用 SMILES 写, 两端加 &, 例如 &CCO&
    写在正文中间或单独占一行都可以, 渲染宽度由是否独占一行决定

例题

  • 用引用块, 编号与教材章号一致, 例如 > 例12-1: ...
  • 题干与解答之间用一行空的 >
  • 解答以 > 解: 起头
  • 结论句以「即」「故」「所以」收尾
  • 例题内的表格与插图整体加 > 前缀

表格

  • 表题在表上方, 格式 表N-M 表题 (条件), 表号后是空格, 不是冒号
  • 表题与表之间空一行
  • 正文里的数据表转为 Markdown 表格, 不裁图
  • 单位用 $.../(\mathrm{...})$
  • 缺项写 —, 趋势用 ↑ ↓
  • 双栏排版的表格按逻辑行顺序展平为一栏

插图

  • 可以不用加文字图注
  • 图号 N 与教材章号一致, 沿用教材原图号, 允许跳号
  • 默认只写空占位 ![图N-M](), 不裁图, 不上传
  • 全部笔记写完再询问用户是否补图
  • 用户确认后才裁剪上传, 把占位换成真实链接
  • 尺寸参数写成 =Wx, W 默认 400, 结构小图 200 到 300, 宽图 500 到 600
  • 裁图时不包含教材印刷的图注

取舍

进笔记

  • 定义, 定律, 判据, 关键公式
  • 推导链, 每步写成一行
  • 数据表, 装置图, 曲线图, 结构式
  • 教材例题, 保持原题, 原数据, 原解法
  • 例外, 反常现象, 适用条件

不进笔记

  • 章首导语, 史实背景, 人物轶事
  • 拓展学习资源, 总结与思考题, 习题
  • 附录里的完整数据表
  • 教材的冗长叙述压缩到 1 到 3 行, 公式与数据不压缩