# 编写规则 [1][2][3][4][5][6]

  • 文件拓展名必须是 .md

  • 文件名必须用小写,多个单词间用 - 分割

  • 文档及字符编码必须用 UTF-8

  • 文档标题用 ## 和标题名称之间加一个空格

  • 文档章节用 #### 和章节名称之间加一个空格

  • 四层级的标题(四级标题已经和正文字体大小差不多)

    # 一级标题
    ## 二级标题
    ### 三级标题
    #### 四级标题
  • 标题需要连续,不要越级

    错误示例:缺少二级标题。一级标题下,不能直接出现三级标题

    # 一级标题
    ### 三级标题
  • 标题要避免孤立编号(即同级标题只有一个)

    错误示例: 二级标题 A 只包含一个三级标题,完全可以省略 三级标题 A

    ## 二级标题 A
    ### 三级标题 A
    ## 二级标题 B
  • 章节和内容间必须有空行

  • 从属章节之间若没有内容不需要空行

  • 代码必须使用围栏代码块(Fencedcodeblocks)风格,即用对称的 ``` 和~~~包裹起来

    ~~~python
    print('Hello World!')
    ~~~
    ```python
    print('Hello World!')
    ```
  • 表格的写法

    First Header  | Second Header
    ------------- | -------------
    Content Cell  | Content Cell
    Content Cell  | Content Cell
    | Left-Aligned  | Center Aligned  | Right Aligned |
    | :------------ |:---------------:| -----:|
    | col 3 is      | some wordy text | $1600 |
    | col 2 is      | centered        |   $12 |
    | zebra stripes | are neat        |    $1 |
  • 中英文混排

    • 英文和数字使用半角字符
    • 中文文字之间不加空格
    • 中文文字与英文、阿拉伯数字及 @#$%^&*.() 等符号之间加空格
    • 中文标点之间不加空格
    • 中文标点与前后字符(无论全角或半角)之间不加空格
    • 如果括号内有中文,则使用中文括号
    • 如果括号中的内容全部都是英文,则使用半角英文括号
    • 当半角符号 / 表示「或者」之意时,与前后的字符之间均不加空格
      CJK 字符和英文之间的盘古之白大部分由 pangu.js 自动添加,其它情况就手调。
  • 中文符号应该使用如下写法:

    • 用直角引号「」代替双引号 “”
    • 省略号使用「……」,而「。。。」仅用于表示停顿
  • 表达方式 [2:1]

    • 使段落成为文章的单元:一个段落只表达一个主题
    • 通常在每一段落开始要点题,在段落结尾要扣题
    • 使用主动语态
    • 陈述句中使用肯定说法
    • 删除不必要的词
    • 避免连续使用松散的句子
    • 使用相同的结构表达并列的意思
    • 将相关的词放在一起
    • 在英文的总结中,要用同一种时态
    • 将强调的词放在句末

# 公式排版 [7]

# 量和单位

# 一、量

  1. 涉及物理量名称时,有专门名称者,应使用国标最新版中推荐使用的名称; 没有专门名称者,应本着命名科学、简明、通俗的原则命名。同一部著作中,同一 个物理量的名称应保持一致,特别是如因引用文献不同而不同时,应修改为同一名 称,或做必要说明和解释。

  2. 量的符号用斜体(pH 除外),矢量、张量和矩阵用黑斜体。

  3. 下角标使用变量符号或表示变数的字母时, 用斜体; 此外的字母符号、 数字用正体。 例如 cpc_p ( pp 表示压力),cwc_\mathrm{w}w\mathrm{w} 表示水)。

  4. 可以将元素符号、 化学式作为量符号使用。 例如: 盐酸的质量不可以写成 HCl=5kg, 而因写成 m (HCl)=5kg;铁的质量分数不可以写成 Fe%=67.89%, 而因写成 w (Fe)=67.89%。

# 二、单位

  1. 单位符号一律用正体,符号中的字母除源于人名单位的首字母要大写,以及升的符 号 “L” 可以大写外,其余均小写。
  2. 相乘的组合单位符号之间,建议采用加间隔号的表示形式,例如 “Nm\mathrm{N\cdot m}”(虽然国标规定还有其他形式)。
  3. 相除的组合单位一般采用 “m/s\mathrm{m/s}” 或 “ms1\mathrm{m\cdot s^{-1}}” 两种形式之一,但须全书统一;分母 由两个以上单位组合构成时,分母中的所有单位要用括号括起,以免引起歧义,单位符号间的比线(/)不能多于一条,例如 “t/(hm2a)\mathrm{t/(h\;m^2\cdot a)}” 。
  4. 过去习称的 “无量纲” 已更名为 “量纲一” 。
  5. 非法定计量单位一般应换算成法定计量单位。若换算为法定计量单位困难很大,且换算后会给读者带来不便时,可根据学术界惯例而保留使用,但应:①或在其后括 注法定计量单位;②或在其第一次出现时加脚注注明其与法定计量单位的换算关 系;③或在书前(或书末)列出书中各种非法定计量单位与法定计量单位的换算表。
  6. 翻译书中的英制单位一般不宜直接改为我国法定计量单位,但应在其后括注法定计量单位。
  7. 书稿中常见的单位 “a 每 b”,如 “rpm”,应按照 “r/min\mathrm{r/min}” 的形式修改。同样,应避 免使用 “ppm” “ppb” 等一类单位符号。不得已使用这些单位时,应指明其与法定 单位或与 10 的幂的关系。

# 参考资料


  1. 技术文档写作规范(Markdown) ↩︎

  2. Markdown 编写规范 ↩︎ ↩︎

  3. Google Markdown 规范 ↩︎

  4. The Element of Style ↩︎

  5. 中文文案排版指北 ↩︎

  6. 不要大喊大叫 —— 小议标点和格式在表达强调中的滥用 ↩︎

  7. LaTeX 公式排版注意事项 / 常见错误 ↩︎