Skip to article frontmatterSkip to article content
Site not loading correctly?

This may be due to an incorrect BASE_URL configuration. See the MyST Documentation for reference.

第一章 总则

第一条 制定依据 本章程旨在建立公司文档写作的格式标准,确保所有正式文档在外观和结构上保持一致。

第二条 目的 为规范文档排版行为,降低阅读成本,消除因格式混乱导致的信息损耗,使读者能够专注于内容本身,特制定本章程。

第三条 适用范围 本章程适用于公司内部所有以 Markdown 编写的正式文档,包括但不限于 Git 仓库文档、飞书文档、内部 Wiki。非正式记录(如个人笔记、临时草稿)不受本章程约束。

第四条 定义 本章程下列用语的含义为:

(一)格式元素,指用于组织或装饰文档内容的 Markdown 语法要素,包括但不限于标题、列表、表格、分隔线、代码块、块引用、加粗、链接。 (二)格式过度,指在同一文档中不必要地使用过多格式元素类型或频次,导致视觉负担加重而非信息清晰度提升的行为。 (三)章程,指公司治理的规范性文件,规定"应当做什么、不得做什么"。

第二章 基本要求

第五条 格式克制原则 文档写作应遵循以下格式克制原则:

(一):删除不必要的格式元素,优先使用段落和标题组织内容; (二):能用列表即不使用表格,能用文字即不使用列表; (三):全文格式元素的数量应控制在必要的最小范围内; (四):同一概念全程使用相同名称,不得混用不同术语指代同一事物。

第六条 格式过度的认定 以下行为构成格式过度:

(一)滥用分隔线装饰章节间隔; (二)任何内容均以列表或表格形式组织; (三)使用"非常"“简单的”"显而易见的"等冗余修饰词。

第七条 AI 写作的格式约束 使用 AI 工具辅助写作时,应将其视为格式执行工具而非格式决策者。提交前须检查并清除 AI 常见的格式过度行为。允许将本章程全文作为提示词提供给 AI,要求其按照本章程输出格式。

第三章 结构规范

第八条 标题层级 文档标题层级应遵守以下规则:

(一)最多使用三级标题(# / ## / ###),不得继续嵌套更深层级; (二)一级标题仅文档主标题使用一次,全文不得出现第二个一级标题; (三)标题应简洁,明确概括该节内容,避免在标题中使用标点符号; (四)标题与正文之间、章节之间应以空行分隔。

第九条 标题大小写 中文文档标题使用中文书写;英文文档标题使用句子大小写(Sentence case),即仅首字母大写,专有名词除外。

第十条 分隔线 分隔线(---)的使用应遵守以下规则:

(一)优先使用空行加标题区分章节,而非分隔线; (二)分隔线仅用于文档中重大的划分节点,全文不得超过三处; (三)分隔线可用于文档顶部元信息与正文之间的分隔,不可在每个章节间重复使用; (四)分隔线不得作为视觉装饰或填充使用。

第四章 排版要素

第十一条 无序列表 无序列表应遵守以下规则:

(一)使用 - 作为列表标记; (二)适用于并列的多个要点、不分先后顺序的内容、短小的条目; (三)列表项以分号结尾或使用完整句,全文保持风格一致; (四)列表项不应过长,超过两行应改用段落; (五)嵌套层级不得超过两级,缩进使用两个空格。

第十二条 有序列表 有序列表应遵守以下规则:

(一)使用 1. 作为列表标记,Markdown 渲染器会自动生成连续编号; (二)适用于有明确顺序的步骤、需要编号的操作流程、排名或优先级; (三)确保每个步骤完整表达。

第十三条 列表使用限制 以下场景不得使用列表代替正文:

(一)仅在描述单一事物时; (二)列表项内容超过两行时; (三)内容之间存在逻辑承接关系,需要用段落表达时。

第十四条 代码块 代码块应遵守以下规则:

(一)必须标注代码语言类型,以便语法高亮; (二)行内代码使用反引号包裹,如 variablefunction()file.md

第十五条 表格 表格的使用应遵守以下规则:

(一)表格仅用于呈现多维度、需对比的数据; (二)表头应加粗,列对齐使用冒号(:-- / :--: / --:); (三)单元格内容应简洁,避免过长; (四)以下场景不得使用表格:仅为简单的名称-定义对应关系(改用列表)、两列且无对比需求、单元格内容需用完整句子表达。

第十六条 链接 链接应遵守以下规则:

(一)外部链接使用标准格式:[链接文本](https://example.com); (二)内部链接使用相对路径:[文档](./docs/guide.md)

第十七条 加粗 加粗应遵守以下规则:

(一)加粗仅用于首次定义关键术语、强调重要操作或警告、引导注意力到关键信息; (二)不得对普通名词或所有术语名词进行加粗; (三)不得连续多个加粗; (四)不得在列表项内部使用加粗。

第十八条 块引用 块引用(>)用于标注重要提示或引用内容,不得作为正文的替代格式。

第十九条 引号 引号的使用应遵守以下规则:

(一)引号用于直接引用他人话语、首次定义术语时标记、强调词汇的特殊含义、标注界面元素名称; (二)英文文档使用双引号("),中文文档使用直角引号(「」); (三)以下场景不得使用引号:对普通名词加引号、在列表项或标题中频繁使用、包裹整个句子作为引用(改用块引用)。

第五章 附则

第二十条 章程效力 本章程经公司治理机构审议通过,自发布之日起生效。已存在的文档与本章程不一致的,应逐步修订以符合本章程的要求。

第二十一条 解释权 本章程之解释,应遵循格式克制之基本原则。各项条文不得被解释为禁止一切格式使用,亦不得被解释为鼓励不经思考的格式滥用。