lailai's Text Format Guide

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

参考资料

• 标点符号用法（GB/T 15834-2011）
• 出版物上数字用法 (GB/T 15835-2011)
• 中文出版物夹用英文的编辑规范（CY/T 154-2017）
• 精品工具书数据库 - 商务印书馆
• 维基百科:格式手册/标点符号 - 维基百科
• 格式手册 - OI Wiki
• 洛谷主题库题解规范 | 洛谷帮助中心
• 中文文案排版指北（简体中文版） - 码志
• 中文文案风格指南 - PDFE GUIDELINE
• 一份（不太）简短的 LaTeX2ε 介绍 - CTeX-org/lshort-zh-cn - GitHub
• 中文技术文档的写作规范 - ruanyf/document-style-guide - GitHub
• Google developer documentation style guide

通用

• 本指南仅适用于 中文技术文本。
• 语言风格应保持 简洁、自然、专业。
• 使用 生成式人工智能（GenAI）辅助文本写作应经过 人工审查。

文件

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

空格

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

标点

• 中文应使用 全角标点，英文应使用 半角标点。
• 句子末尾应使用 句号（。）、问号（？）、叹号（！）或 省略号（……）。
• 应正确使用 逗号、顿号和分号。
• 应使用 直角引号（「」、『』）而非弯引号（“”、‘’）。
• 引号嵌套应交替使用 单引号和双引号。
• 表示 强调 应使用 加粗或斜体 而非引号。
• 标有 引号或书名号 的并列成分之间不应使用 顿号。
• 应正确使用各种不同的 连接号：
  • -（U+002D，Hyphen，连字符）；
  • –（U+2013，En dash，短破折号）；
  • —（U+2014，Em dash，长破折号）。
• 不应重复使用标点符号。

翻译

• 对于 译法存在争议的专有名词 应使用原文。
• 翻译应遵循 信达雅，使用可以读懂的 翻译和缩写。
• 不应使用不地道的 翻译和缩写，例如「USB 通用串行总线」「NBA 美国职业篮球联赛」。
• 应使用 大小写正确的专有名词，例如「GitHub」「iPhone」。
• 同时出现 中文、原文和缩写 时，应使用 中文（原文，缩写） 的格式，例如「快速傅里叶变换（Fast Fourier Transform，FFT）」「世界卫生组织（World Health Organization，WHO）」。
• 不应在文本中夹杂不必要的 英文单词，例如「这个想法很低级 这个 idea 很 low」。

句子

• 避免使用 长句，每句不应超过 $40$ 字。
• 应使用 简单句和并列句，避免使用复合句。
• 避免使用 双重否定句。
• 通常应使用 主动语态，避免使用被动语态，例如「程序会自动保存设置 设置会被程序自动保存」。
• 应使用现代汉语的常用表达方式，不应使用冷僻、生造和文言文词语。
• 不应使用非正式的语言风格。

词语

• 代词应指代清晰，避免产生歧义。
• 避免不必要的 形容词和语气词。
• 避免不必要的 网络流行语和谐音错别字。
• 通常应使用「你」而非「您」。
• 通常应使用「仅」而非「只」。
• 应正确使用「的」「地」「得」。
• 应正确使用「他」「她」「它」。
• 应正确使用「与」「和」「或」。
• 应使用「连通」而非「联通」。
• 应使用「若」而非「如果」。

数学

• 数字通常使用 半角字符 的 阿拉伯数字。
• 正式文本的数字和约定俗成的词语应使用 中文数字，例如「三局两胜」「十二生肖」。
• 数字通常不使用 千分位。
• 时间格式应遵循 ISO 8601，例如「1969-07-20」「20:17:40」。
• 货币格式应遵循 ISO 4217，例如「USD 19.99」「CNY 6,599」。
• 表示 数值范围 应使用 波浪线（~）。
• 数值增加 应使用「增加了」「增加到」，数值减少 应使用「降低了」「降低到」。

Markdown

• 每篇文本最多包含 $1$ 个 一级标题，即文章的总标题。
• 其余内容应使用 二级、三级、四级标题，避免使用 五级、六级标题。
• 各级标题末尾不应添加标点符号。
• 不应跳过标题等级。
• 上下级标题不应相同。
• 不应孤立标题编号，即上级标题中不应仅有 $1$ 个下级标题。
• 表示 加粗 应使用 双星号（**）。
• 表示 斜体 应使用 单下划线（_）。
• 表示 无序列表 应使用 连字符（-）。
• 若列表项目为完整句子，末尾应使用句号；若为短语或单词，末尾不应使用标点。
• 行间代码应标记 代码语言，纯文本应标记为 text。
• 链接文本应具有 描述性。
• 图片应包含 替代文本。

LaTeX

• 数学公式应使用 $\LaTeX$。
• 行间公式前后的 双美元符号（$$）应 单独一行。
• 公式不应放在 标题、加粗、斜体、链接 等格式中。
• 公式应使用 数学语言 而非代码语言。
• 变量名 应使用 $1$ 个字母，不应使用多个字母。
• 大数字 应使用 科学计数法。
• 乘法 应使用 \times 或 \cdot 而非 *。
• 取模 应使用 \bmod 或 \pmod 而非 % 和 \mod。
• 分数 应使用 \frac 而非 \dfrac。
• 横向省略号 应使用 \dots 而非 \cdots 和 \ldots。
• 未定义但约定俗成的函数 应使用 \operatorname，例如「 \operatorname{lca}」。
• 赋值 应使用 \to 和 \gets。
• 空集 应使用 \varnothing 而非 \emptyset。
• 逻辑 应使用 \implies、\impliedby 和 \iff。
• 包裹大高度公式的括号 应使用 \left 和 \right。
• 复杂度 应使用大 $O$ 记号，不应带有常数。

lailai's Home

• lailai 始终应排印为小写，即使它出现在句首、段落开头或标题中。
• lailai 为不翻译内容，始终以英语排印，即使它出现在非英语的语言文本中也是如此。
• lailai should always be typeset with all lowercase letters, even when it is the first word in a sentence, paragraph, or title.
• lailai is untranslatable content and should always be set in English, even when it appears within text in a language other than English.
• 对于 尚未撰写和未完成的内容，应使用 [TODO] 标记。
• 表示 告示 应使用 三冒号（:::）和类型标签。