跳到主要内容

lailai's Text Format Guide

本文为我的文本格式指南。

参考资料​

通用​

  • 本指南仅适用于 中文技术文本。
  • 本指南的规范强度分为 44 个等级：
    • 应（Must）：强制执行。
    • 通常（Should）：推荐执行。
    • 避免（Should Not）：不推荐使用。
    • 不应（Must Not）：禁止使用。
  • 语言风格应保持 简洁、自然、专业。
  • 生成式人工智能（GenAI）辅助创作文本时，应经过 人工审核。

文件​

  • 文件编码应使用 UTF-8。
  • 文件名应遵循 kebab-case，即使用 小写字母和数字，避免使用大写字母、中文和空格。
  • 文件名的语义应使用 英文单词和缩写，避免使用汉语拼音。
  • 文件名包含多个部分时，应使用 连字符（-）分隔，避免使用下划线（_），例如「text-format.md」。
  • 纯文本文件的扩展名应使用 .txt；Markdown 文件的扩展名应使用 .md；LaTeX\LaTeX 源文件的扩展名应使用 .tex。
  • Markdown 和 LaTeX\LaTeX 文本应使用 22 个 Space 缩进，空行不应缩进。
  • 文件应以 front matter 开头，应包含以下字段：
    • title：文本标题，不应使用一级标题。
    • description：内容概述，例如「本文将介绍……」「本文为……」。
  • 文件应以 11 个 空行 结尾。
  • 不应连续使用 22 个空行。

空格​

  • 中文 和 英文、数字 之间应添加空格。
  • 中文 和 加粗、斜体、链接、代码、公式 等格式之间应添加空格。
  • 数字 和 单位 之间应添加空格，和简写计数、百分号（%）、角度（°）之间不应添加空格。
  • 全角标点 前后不应添加空格。
  • 专有名词 应使用 官方规定的书写格式，例如「QQ音乐」「豆瓣FM」。

标点​

  • 中文应使用 全角标点，英文应使用 半角标点。
  • 标题末尾不应添加标点符号。
  • 句子末尾应添加 句号（。）、问号（？）、叹号（！）、省略号（……）。
  • 多处并列成分之间应使用 顿号（、），两处应使用「和」或「或」。
  • 标有 引号或书名号 的并列成分之间不应添加标点符号。
  • 对于 无序列表和任务列表，每项末尾应添加 句号（。）。
  • 对于 有序列表，每项末尾应添加 分号（；），最后一项末尾添加 句号（。）。
  • 全角引号 应使用 直角引号（「」 和 『』）而非弯引号（“” 和 ‘’），半角引号应使用 "" 和 ''。
  • 引号嵌套应交替使用 单引号和双引号。
  • 中文省略号 应使用 ……，英文省略号 应使用 ...。
  • 应正确使用 连接号：
    • 连字符（-，Hyphen，U+002D）：连接复合词。
    • 短破折号（–，En dash，U+2013）：连接对等专有名词、表示范围、表示占位符。
    • 长破折号（—，Em dash，U+2014）：表示句内破折号。
  • 不应重复使用标点符号，例如「真的？！ 真的？？！！」。

词句​

  • 用词应遵循 用词规范指南。
  • 代词应指代清晰，避免产生歧义。
  • 避免使用 不必要的形容词和语气词。
  • 避免使用 网络流行语、谐音错别字、Emoji 表情包、颜文字。
  • 避免使用 冷僻、生造、文言文 词语。
  • 句子应使用 现代汉语 的常用表达方式，不应使用 非正式 的语言风格。
  • 避免使用 长难句，每句避免超过 4040 字，不应超过 6060 字。
  • 应使用 简单句和并列句，避免使用复合句。
  • 应使用 主动语态，避免使用被动语态，例如「程序会自动保存文件 文件会被程序自动保存」。
  • 避免使用 双重否定句。

翻译​

  • 翻译应遵循 信达雅 原则。
  • 应使用可以读懂的 翻译和缩写，译法存在争议的专有名词应使用权威或主流译名。
  • 首次出现 专业术语 应使用 中文全称（原文全称，缩写） 的格式，例如「快速傅里叶变换（Fast Fourier Transform，FFT）」「国内生产总值（Gross Domestic Product，GDP）」。
  • 首次出现 外国人名 应使用 中文译名（原文姓名，生卒年） 的格式，例如「艾萨克·牛顿（Isaac Newton，1643–1727）」「埃隆·马斯克（Elon Musk）」。
  • 应使用 大小写正确的专有名词，例如「YouTube」「GitHub」「iPhone」「McDonald's」。
  • 避免使用 不地道的翻译和缩写，例如「USB 通用串行总线」「NBA 美国职业篮球联赛」。
  • 避免使用 不必要的英文单词，例如「这个想法很好 这个 idea 很好」。

数字​

  • 数字通常使用 半角字符 的 阿拉伯数字，不使用 千分位。
  • 正式文本和约定俗成词语中的数字应使用 中文数字，例如「三局两胜」「十二生肖」。
  • 表示 数值增加 应使用「增加了」「增加到」，表示 数值减少 应使用「降低了」「降低到」。
  • 时间格式 应遵循 ISO 8601，例如「1969-07-20」「20:17:40」。
  • 货币格式 应遵循 ISO 4217，例如「USD 19.99」「CNY 6599」。
  • 电话号码 应遵循 E.164，使用 +国家代码 号码 的格式，例如「+86 17757102577」。

Markdown​

  • Markdown 应遵循 Markdown 指南。
  • 应使用 二级、三级、四级标题，避免使用 五级、六级标题，不应使用 一级标题。
  • 不应跳过标题等级，不应使用相同的上下级标题。
  • 不应孤立标题编号，即上级标题中不应仅有 11 个下级标题。
  • 表示 加粗 应使用 22 个 星号（**），不应使用引号。
  • 表示 斜体 应使用 11 个 下划线（_），避免使用斜体。
  • 表示 无序列表 应使用 连字符（-）。
  • 表格 应使用 居中对齐（:-:）。
  • 分隔线 应使用 33 个 连字符（---）。
  • 行间代码应标记 代码语言，纯文本应标记为 text。
  • 链接文本应具有 描述性，相对路径应省略前缀 ./。
  • 图片应添加 替代文本。
  • 表示 键盘按键 应使用 <kbd>，例如「<kbd>⌘</kbd> + <kbd>C</kbd>」。
  • 表示 界面元素 应使用 方括号（[]）。

LaTeX​

  • LaTeX\LaTeX 应遵循 LaTeX 指南。
  • 数学公式应使用 LaTeX\LaTeX。
  • 行间公式前后的 22 个 美元符号（$$）应 单独一行。
  • 公式不应放在 标题、加粗、斜体、链接 等格式中。
  • 公式应使用 数学语言 而非代码语言：
    • 赋值 应使用 \to 或 \gets 而非 =。
    • 取模 应使用 \bmod 或 \pmod 而非 % 和 \mod。
    • 整除 应使用 \lfloor 和 \rfloor。
    • 数列 应使用 a_i 而非 a[i]。
    • 位运算 应使用 \operatorname{and}、\operatorname{or}、\operatorname{xor}。
  • 公式文本 应使用 \text，字符串 应使用 \texttt。
  • 变量名 应使用 11 个字母，不应使用多个字母。
  • 乘法 应使用 \times 或 \cdot 而非 *。
  • 分数 应使用 \frac 而非 \dfrac。
  • 绝对值 应使用 || 而非 \lvert 和 \rvert。
  • 横向省略号 应使用 \dots 而非 \cdots 和 \ldots，纵向省略号 应使用 \vdots，斜向省略号 应使用 \ddots。
  • 未定义但约定俗成的函数 应使用 \operatorname，例如「 \operatorname{lca}」。
  • 物理单位 应使用 \mathrm，例如「\mathrm{m/s^2}」。
  • 特殊数集 应使用 \mathbb，例如「\mathbb{R}」。
  • 空集 应使用 \varnothing 而非 \emptyset。
  • 逻辑 应使用 \implies、\impliedby、\iff。
  • 包裹大高度公式的括号 应使用 \left 和 \right。
  • 复杂度 应使用大 OO 记号，不应带有常数。
  • 大数字 应使用 科学计数法。

lailai's Home​

  • 本章仅适用于 lailai's Home。
  • 资源应使用 lailai's Cloud。
  • 尚未撰写或完成的内容 应使用 [TODO] 标记。
  • 表示 告示 应使用 33 个 冒号（:::）和类型标签。
  • lailai 始终应排印为小写，即使它出现在句首、段落开头或标题中。lailai should always be typeset with all lowercase letters, even when it is the first word in a sentence, paragraph, or title.
  • lailai 为不翻译内容，始终以英语排印，即使它出现在非英语的语言文本中也是如此。lailai is untranslatable content and should always be set in English, even when it appears within text in a language other than English.
  • 包含 lailai's 的短语为不翻译内容，始终以英语排印，后面每个单词应首字母大写，例如「lailai's Home」「lailai's Text Format Guide」。