创游世界资料库

外观

写作：待补充更新：2026-05-16字数：—阅读：—维护：Azek431

创游世界知识库文档格式规范 ​

一句话摘要 ​

本文档规定创游世界知识库（cysj-data）所有文档的 VitePress Markdown 格式标准，包括 frontmatter 元数据规范、标题层级、链接写法、内容结构与 SEO 要求。所有贡献者必须遵循本规范提交文档。

适合谁阅读 ​

  • 想为知识库贡献文档的创作者
  • 需要了解知识库文档格式的维护者
  • 想在知识库发布个人整理资料的社区成员

你将学到什么 ​

  • VitePress frontmatter 的标准写法
  • 标题层级的正确使用方式
  • 站内链接和站外链接的规范格式
  • 内容结构的推荐模板
  • SEO 元数据的填写要求
  • 证据等级的标注规范

frontmatter 规范 ​

每篇文档开头必须包含完整的 frontmatter，使用 YAML 格式。

标准 frontmatter 模板 ​

yaml
---
title: 页面标题
description: 用一句话说明这篇文档解决什么问题。
editor: Azek431
status: 整理中
difficulty: 入门
evidence: 资料整理
updated: 2026-05-16
category: 所属分类
version: v0.1.x
tags:
  - 创游世界
  - 相关标签1
  - 相关标签2
---

各字段说明 ​

字段必填说明示例
title✅文档标题，会显示在浏览器标签和页面顶部创游世界广播机制完全指南
description✅一句话描述，用于 SEO 和 AI 检索摘要讲解广播机制的完整使用方法和最佳实践
editor✅文档维护者Azek431
status✅文档状态见下方状态说明
difficulty✅适合的难度等级入门 / 进阶 / 高级 / 研究向
evidence✅证据等级见下方证据等级说明
updated✅最后更新日期（YYYY-MM-DD）2026-06-01
category✅所属分类见分类对照表
version✅文档版本v0.1.x
tags✅关键词标签（至少2个）见下方标签说明

status 状态可选值 ​

状态含义
草稿初始内容，尚不完整
整理中正在整理，有基本框架但需完善
已结构化结构完整，内容基本可靠
待验证核心内容需要验证
已复核经过人工复核，内容可信
持续维护持续更新维护的活跃文档

evidence 证据等级可选值 ​

等级含义
E1 直接证据官方截图、官方教程原文、官方更新说明
E2 OCR/转写证据截图 OCR 转写，需人工复核
E3 归纳结论多来源交叉验证后的合理结论
E4 社区经验/推测社区经验或合理推断，未必完全准确
资料整理以整理归纳已有资料为主
待验证证据不足，需要进一步验证

category 分类对照表 ​

分类说明
总索引与导航首页、新手路线、知识库总导航
教程资料官方教程、学习路线、速查指南
核心研究脚本、变量、广播、组件、UI、碰撞、联机
脚本系统脚本编辑器、积木块、API整理、命名规范
项目设计商店、背包、地图、任务、道具、存档
OCR资料截图转文本、映射表、证据链说明
引擎更新版本演进、4.54.0特性、联机UI
社区分析用户解析、待验证问题
维护与报告贡献指南、运维方案、更新日志
元信息术语表、标签体系、文档状态

tags 标签规范 ​

  • 每个文档至少 2 个 tags
  • tags 要具体，不要太泛（如「游戏」太泛，「创游世界」更具体）
  • 推荐包含：创游世界 + 核心主题词 + 类型词
  • 示例：
    • 创游世界、广播、事件系统、解耦（好）
    • 游戏（差）

标题层级规范 ​

正确的层级结构 ​

# 一级标题（页面大标题）

## 二级标题（主要章节）

### 三级标题（子章节）

#### 四级标题（细节内容，通常不推荐使用）

规范要点 ​

  1. 一个页面只有一个一级标题（即 # 标题，对应 frontmatter 的 title）
  2. 不要跳级：不要从 # 直接跳到 ###
  3. 标题要有语义：能概括下面的内容，不要用无意义的标题如「一些说明」
  4. 避免标题过长：尽量控制在 30 个字符以内

常见错误 ​

错误问题正确
多个 # 标题一个页面有多个主标题只用一个 #
# 标题 然后 ####跳级加 ## 或 ###
「关于xxx的说明」标题太长「xxx 说明」
「注意事项」无语义「注意事项」可接受，但「UI 注意事项」更好

内容结构规范 ​

推荐的内容结构 ​

虽然不是每篇文档都要机械套用，但以下结构是推荐的标准模板：

markdown
## 一句话摘要
用 1-3 句话说明这篇文档讲什么。

## 适合谁阅读
说明文档适合哪些读者。

## 你将学到什么
用列表说明读者读完能获得什么。

## 核心结论
先给重要结论，不要绕弯子。

## 背景说明
解释为什么这个主题值得单独整理。

## 基础概念
用新手能理解的语言解释相关概念。

## 详细解析
结合资料库已有内容进行深入说明。

## 示例说明
提供场景、操作思路、伪代码、项目设计例子。

## 常见问题
整理读者可能会遇到的问题（FAQ 形式）。

## 注意事项
标出容易误解、容易踩坑、需要验证的地方。

## 相关页面
补充站内相关文档链接。

## 待验证问题
列出不能确定的内容。

## 后续优化方向
说明这篇文档以后还能补什么。

不要这样做 ​

错误做法说明
空泛宣传句不要写「非常强大」「特别好用」等无信息量的话
堆砌关键词不要为 SEO 重复堆砌相同关键词
把推测写成事实不能确定的内容要标注「待验证」
堆废话凑字数不要为显得「完整」而加废话
步骤缺失操作指南要给完整步骤，不能跳步

链接规范 ​

站内链接 ​

使用 VitePress 可识别的相对路径或站内路径：

markdown
<!-- 推荐：使用站内路径 -->
[新手阅读路线](/总索引与导航/新手阅读路线.md)
[广播机制完全指南](/核心研究/创游世界广播机制完全指南.md)

<!-- 不推荐：使用绝对路径 -->
[新手阅读路线](https://cysjdocs.dpdns.org/总索引与导航/新手阅读路线)

站外链接 ​

  • 外部链接使用完整 URL
  • 添加说明文字，不要只写 URL
  • 重要外部链接在文档中说明来源
markdown
<!-- 推荐 -->
[GitHub 仓库](https://github.com/Azek431/cysj-data)

<!-- 不推荐 -->
请访问 https://github.com/Azek431/cysj-data

代码与示例规范 ​

代码块 ​

所有代码、命令、脚本使用代码块包裹：

markdown
```javascript
// 示例代码
const variable = 0;

### 命令块

终端命令使用 `bash` 或 `shell` 语言标识：

```bash
pnpm run docs:preview
git add -A
git commit -m "feat: 新增文档"

伪代码与操作步骤 ​

可以使用「三引号块 + 说明」的形式表示操作步骤，不需要真实语法：

1. 打开编辑器
2. 新建项目 → 命名为「练习」
3. 添加角色到地图

表格规范 ​

使用 Markdown 标准表格，列对齐要有意义：

markdown
| 列1 | 列2 | 列3 |
|------|------|------|
| 内容1 | 内容2 | 内容3 |
| 内容4 | 内容5 | 内容6 |

表格规范 ​

  1. 表头和内容用 | 分隔
  2. 用 - 分隔表头和内容行
  3. 表格前后要留空行
  4. 不要在表格内嵌套复杂格式

引用块（Blockquote） ​

重要提示使用 > 引用块：

markdown
> **注意**：这是一个重要提示，应该用引用块突出显示。

引用块使用场景 ​

  • 重要警告或注意事项
  • 核心结论的再次强调
  • 需要特别关注的操作步骤

列表规范 ​

有序列表 ​

用于步骤说明：

markdown
1. 第一步
2. 第二步
3. 第三步

无序列表 ​

用于分类列举：

markdown
- 列表项一
- 列表项二
  - 子项一
  - 子项二

列表规范 ​

  1. 列表前后要留空行
  2. 不要在列表中嵌套过多层级（建议不超过 3 层）
  3. 列表项末尾不要加句号

SEO 规范 ​

title 优化 ​

  • title 包含核心关键词
  • 控制在 60 个字符以内
  • 格式建议：核心主题 - 补充说明

description 优化 ​

  • description 清楚说明页面价值
  • 控制在 150 个字符以内
  • 要包含核心关键词
  • 一句话概括，不要写成广告

tags 优化 ​

  • tags 要具体，不要泛
  • 包含主题词 + 类型词
  • 每个文档至少 2 个 tags

证据与可信度标注 ​

必须标注的情况 ​

内容类型标注方式
OCR 转写内容> E2 OCR/转写证据 + > 需人工复核
社区经验标注「社区观察」或「经验归纳」
未验证内容标注 [待验证] 或 > [待验证]
推测内容标注「推断」或「推测」

标注示例 ​

markdown
> E2 OCR/转写证据：以下内容来自创游世界官方教程截图 OCR 转写，识别准确率约 90%，存在少量错别字需人工复核。

> [待验证]：以下内容基于社区经验归纳，尚未有官方文档直接确认，请自行测试验证。

> 社区观察：以下内容来自创游世界社区创作者分享的个人经验，可能不适用于所有场景。

文档命名规范 ​

文件命名 ​

  • 使用中文命名，可读性好
  • 避免无意义命名（如「新建文档1」）
  • 扩展名使用 .md

推荐命名格式 ​

创游世界XXX完全指南.md      # 完全指南类
创游世界XXX入门.md           # 入门教程类
创游世界XXX速查卡.md         # 速查参考类
创游世界XXX研究.md           # 研究分析类
XXX专题导航.md               # 导航索引类
XXXFAQ.md                    # 常见问题类

常见错误检查清单 ​

提交文档前，请逐项检查：

  • [ ] frontmatter 完整且字段正确
  • [ ] 只有一个 # 一级标题
  • [ ] 标题层级不跳级
  • [ ] description 在 150 字符以内
  • [ ] tags 至少 2 个且具体
  • [ ] 站内链接使用相对路径
  • [ ] 代码使用代码块包裹
  • [ ] 表格前后有空行
  • [ ] 推测内容标注了 [待验证]
  • [ ] OCR 内容标注了证据等级
  • [ ] 没有空泛宣传句
  • [ ] 没有堆砌关键词

相关页面 ​

待验证问题 ​

  • [待验证] VitePress 搜索功能的具体配置对文档的影响
  • [待验证] 不同 frontmatter 字段对 SEO 权重的影响程度

参与维护

发现文档问题？

你可以编辑页面、提交反馈，或复制链接给维护者，帮助这个资料库继续变好。

编辑此页反馈建议

由 Azek431 整理与维护 | 基于 MIT 许可证开源

Copyright © 2026 Azek431 | 内容仅供学习参考，请遵守相关法律法规