写作质量标准
文档写作的质量标准——中文写作规范、术语一致性、排版规则、代码示例规范与常见错误纠正
基础
官方•Dingding OvO · 2026-08-12文档质量不仅取决于内容准确性，还取决于写作质量。糟糕的写作会让读者困惑、误解甚至放弃阅读。本文档定义 MCBECD 文档的中文写作规范、术语一致性和排版规则。
一、语言要求
1.1 语言选择
所有文档使用简体中文编写。以下情况例外：
- 命令名称本身（如
/give、@p、diamond_sword） - 物品 ID、方块 ID、实体 ID（如
stone、zombie） - 代码块中的命令内容
- 外部链接的 URL
1.2 中英文混排规则
当中文文本中包含英文单词或代码片段时，中英文之间加一个半角空格。
正确示例：
使用 /give 命令给予玩家物品。
选择器 @p 表示最近的玩家。
物品 ID 为 diamond_sword。
详见 /execute 命令文档。
错误示例：
使用/give命令给予玩家物品。
选择器@p表示最近的玩家。
物品ID为diamond_sword。
详见/execute命令文档。
例外：中文标点符号（如句号、逗号、冒号）与英文之间不加空格。
正确：使用 /give 命令，可以给予玩家物品。
错误：使用 /give 命令 , 可以给予玩家物品。
1.3 标点符号
使用中文标点符号：
| 场景 | 正确 | 错误 |
|---|---|---|
| 句末 | 中文句号 。 | 英文句号 . |
| 逗号 | 中文逗号 ， | 英文逗号 , |
| 冒号 | 中文冒号 ： | 英文冒号 : |
| 分号 | 中文分号 ； | 英文分号 ; |
| 括号 | 中文括号 （） | 英文括号 () |
| 引号 | 中文引号 "" | 英文引号 "" |
例外：代码块内、行内代码内、URL 内使用英文标点。
1.4 数字用法
- 整数使用阿拉伯数字：
1、10、64 - 不使用中文数字：一、十、六十四
- 版本号使用阿拉伯数字：
1.20.50 - 范围使用波浪号或连字符：
1-64、10~20 - 坐标使用波浪号：
~ ~1 ~、^ ^ ^1
二、术语一致性
MCBECD 文档中涉及的 Minecraft 术语必须保持一致。以下术语表是权威参考。
2.1 命令术语
| 正确术语 | 错误术语 | 说明 |
|---|---|---|
| 命令方块 | 指令方块、命令块 | 统一使用「命令方块」 |
| 脉冲命令方块 | 脉冲方块 | 使用完整名称 |
| 重复命令方块 | 循环命令方块 | 使用「重复」而非「循环」 |
| 连锁命令方块 | 链式命令方块 | 使用「连锁」 |
| 条件命令方块 | 有条件命令方块 | 使用「条件」 |
| 循环执行 | 重复执行 | 与「重复命令方块」保持一致 |
| 选择器 | 目标选择器 | 简称为「选择器」 |
| 聊天栏 | 聊天框、聊天窗口 | 统一使用「聊天栏」 |
| OP 等级 | 管理员等级、权限等级 | 统一使用「OP 等级」 |
| 计分板 | 记分板、分数板 | 统一使用「计分板」 |
| 基岩版 | Bedrock Edition、BE | 统一使用「基岩版」 |
| Java 版 | Java Edition、JE | 统一使用「Java 版」 |
| 网易版 | 中国版、国际服 | 统一使用「网易版」 |
| 国际版 | 国际服、外服 | 统一使用「国际版」 |
2.2 游戏概念术语
| 正确术语 | 错误术语 |
|---|---|
| 物品栏 | 背包、库存 |
| 物品 ID | 物品代码、物品名称 |
| 方块 ID | 方块代码 |
| 实体 | 生物、怪物 |
| 掉落物 | 掉落 |
| 附魔 | 附魔属性、附魔效果 |
| 游戏刻 | tick、刻 |
| 红石信号 | 红石电流 |
| 常加载区域 | 永久加载区域、强制加载区域 |
2.3 技术术语
| 正确术语 | 错误术语 |
|---|---|
| frontmatter | 头部信息、元数据 |
| MD | Markdown |
| 子模块 | 子仓库 |
| GitHub | github |
| Pull Request | PR、拉取请求 |
| 提交 | commit |
| 分支 | branch |
三、排版规则
3.1 段落
- 每个段落至少 2 句话
- 段落之间用空行分隔
- 不使用多个连续空行（最多一个空行）
- 不使用缩进（MD 不支持段落缩进）
3.2 列表
- 列表项之间不留空行
- 列表嵌套时使用 2 个空格缩进
- 列表项符号使用
-（不使用*或+） - 每个列表项的内容简洁明确
正确示例：
- `<玩家>` — 目标选择器
- `<物品>` — 物品 ID
- `[数量]` — 数量（1-64）
错误示例：
* 玩家 — 目标选择器
* 物品 — 物品 ID
（使用 *、列表项之间有空行）
3.3 标题
- 不要在标题末尾加标点符号
- 标题不要太长（建议不超过 20 个字）
- 标题和上方文本之间留一个空行
- 标题和下方文本之间不留空行
3.4 代码块
- 代码块使用三个反引号
- 指定语言标记
- 代码块前后各留一个空行
- 代码块内不添加注释（说明写在代码块外部）
3.5 表格
- 表头行与分隔线之间不留空行
- 数据行之间不留空行
- 单元格内容简洁
- 不使用空单元格
四、常见写作错误纠正
4.1 空洞描述
错误：/give 命令可以给玩家物品。
正确：给予玩家指定物品。基岩版 1.20.50+ 已弃用旧版数据值语法，改用物品组件系统。
4.2 模糊表述
错误：这个命令有很多参数。
正确：/clone 命令有 6 个参数：起点坐标、终点坐标、目标位置、遮罩模式、克隆模式和方块过滤。`
4.3 不完整示例
错误：
/give @p diamond
正确：
<CmdChat>`/give @p diamond 64`
给予最近的玩家 64 个钻石。
4.4 错误的技术信息
错误：/execute 需要 OP 等级 1。
正确：/execute 需要 OP 等级 2。
（维护者在审核时应特别注意此类错误）
五、风格指南
5.1 语气
MCBECD 文档使用专业但不生硬的语气：
- 使用第二人称（「你」「你的」）
- 直接说明，不客套
- 不使用感叹号
- 不使用emoji
正确：
使用 @p 选择最近的玩家。
错误：
请使用 @p 选择最近的玩家哦！😊
5.2 简洁性
- 不要重复信息
- 不要添加不必要的解释
- 一个概念只解释一次
- 避免冗长的前缀（如「现在我们来学习……」「接下来介绍……」）
5.3 准确性
- 所有命令语法必须经过游戏内测试验证
- 版本号必须准确
- OP 等级要求必须准确
- 不确定的信息标注为「待验证」