社区文档标准

社区文档是 MCBECD 文档库中由社区贡献的教程、工具和玩法文档。社区文档面向实际使用场景，帮助玩家在游戏中实现具体功能。本文档定义社区文档的收录范围、编写规范、质量要求和审核标准。

一、收录范围

1.1 收录的内容类型

社区文档收录以下类型的内容：

命令方块搭建教程：使用命令方块实现的完整系统（如雪球菜单、自动售货机、传送系统）
计分板系统教程：使用计分板实现的数据追踪、经济系统、排行榜等
红石+命令结合的创意玩法：结合红石电路和命令的创意实现
服务器管理工具：服主管理服务器的命令工具和脚本
原版命令实现的实用功能：仅使用原版命令（无需附加包）实现的实用功能

1.2 不收录的内容

以下内容不在社区文档的收录范围内：

纯红石电路：不涉及任何命令的红石电路设计
需要附加包/模组的功能：依赖行为包、资源包或模组才能实现的功能
与命令无关的游戏攻略：如刷怪塔设计（纯建筑）、生存技巧（不涉及命令）等
软件安装教程：如安装服务器端、安装启动器等
视频嵌入：MCBECD 文档不支持视频内容
图片为主的教程：MCBECD 文档暂不支持图片

1.3 边界判断

如果一篇文档的核心内容是命令的使用，但涉及少量红石（如用红石控制命令方块的开关），则属于收录范围。判断标准：命令是否是文档的核心教学内容。

二、Frontmatter 要求

社区文档的 frontmatter 必须遵循以下格式：

---
author: "作者名"
updatedAt: "2026-08-12"
title: "功能名称"
description: "一句话描述功能，15-40字"
tags: ["内容类型", "技术栈", "标签"]
---

2.2 tags 字段

社区文档的 tags 字段必填。标签组成规则：

1 个内容类型标签（教程/工具/玩法/技巧/红石电路）
1-2 个技术栈标签（计分板/命令方块/标签系统/execute/原版）
可选：场景标签或属性标签

示例：

tags: ["工具", "命令方块", "计分板", "execute", "原版"]
tags: ["教程", "命令方块", "原版"]
tags: ["技巧", "命令方块", "循环"]

详细标签定义见标签标准规范。

三、文件命名与编号

3.1 命名规则

文件名 = 纯数字编号 + .md

编号从 1 开始递增
不补零、不加前缀、不加英文描述
存放在仓库根目录

3.2 编号分配

查看根目录下已有的最大编号
使用下一个连续编号
不跳号、不重用已删除编号

3.3 title 与文件名的关系

社区文档的 title 字段是功能的中文名称，与文件名（数字编号）无关。文件名仅用于排序和 ID，title 才是显示在站点上的名称。

示例：

文件 3.md 的 frontmatter：

title: "雪球菜单"

站点上显示的名称是「雪球菜单」，URL 是 /docs/3。

四、内容结构规范

4.1 功能描述（开头段落）

文档开头用 1-3 句话描述功能的核心内容。

4.2 前置指令（`### 前置指令`）

如果功能需要提前创建基础设置（计分板、游戏规则等），使用此章节。

每个前置指令使用 <CmdChat> 组件，并简要说明作用。

4.3 搭建步骤

按步骤列出命令方块的摆放方式和指令内容。

要求：

使用 ### 或 #### 分组
每个指令使用对应的 <CmdXxx> 组件
注明方块类型（脉冲/重复/连锁/条件）
注明方块设置（保持开启/需要红石/延迟等）
指令按执行顺序编号

4.4 常见问题

使用 <details> / <summary> 折叠列出 FAQ。

4.5 基岩版注意

如有版本差异，列出注意事项。

五、质量要求

5.1 指令可执行性

所有指令必须是完整可执行的。读者应能直接复制粘贴到游戏中使用。

5.2 步骤完整性

命令方块的类型和设置必须写明
命令方块之间的箭头方向必须说明
延迟设置必须写明
所有前置条件必须列出

5.3 常见问题覆盖

至少覆盖以下常见问题（如适用）：

为什么离远了没有效果？（常加载区域问题）
为什么一直重复执行？（分数未重置）
为什么没有反应？（方块顺序/方向错误）
网易版是否可用？

六、审核标准

维护者审核社区文档 PR 时检查以下项目：

tags 是否包含 1 个内容类型 + 1-2 个技术栈
title 格式是否正确
前置指令是否使用 <CmdChat>
命令方块指令是否使用了正确的 <CmdXxx> 组件
方块类型和设置是否标注
常见问题是否使用 <details> 折叠
是否有至少 3 个常见问题
指令是否可直接复制使用
是否包含「基岩版注意」（如适用）