Skip to content
写作:2026-05-13更新:2026-05-16字数:—阅读:—维护:Azek431

知识库结构与维护指南

一句话摘要

本文档说明创游世界知识库的目录结构、文档分类规则、维护流程与贡献方式,帮助你快速理解资料库的组织方式并参与维护。

适合谁阅读

  • 想参与资料库维护的贡献者
  • 想知道资料库组织方式的普通用户
  • 需要查找特定主题但不知道从哪入手的访客
  • 需要理解文档分类规则的 AI 检索系统

你将学到什么

  • 知识库的十大分类目录及其用途
  • 文档的命名规范和 frontmatter 要求
  • 文档状态分级与证据等级标准
  • 如何贡献新文档或优化已有文档
  • 文档的 SEO 与 AI 检索优化方法

一、知识库十大分类目录

1. 总索引与导航 (docs/总索引与导航/)

用途:面向新手的入口页面和学习路线规划。

核心文档

适合:第一次使用知识库的用户


2. 教程资料 (docs/教程资料/)

用途:收录创游世界的教程类资料,包括官方教程索引、学习路线、专题研究、B站视频资源等。

核心文档

专题研究目录 (docs/教程资料/专题研究/):

适合:所有学习阶段的用户


3. 脚本系统 (docs/脚本系统/)

用途:脚本系统的核心文档和专题研究,涵盖脚本界面、积木能力、数据流、API、组件体系与实战架构。

核心文档

专题研究目录 (docs/脚本系统/专题研究/):

入门系列

进阶系列

项目架构系列

系统设计系列

适合:进阶用户、项目制作者


4. 核心研究 (docs/核心研究/)

用途:核心机制研究的聚合导航,涵盖脚本系统、UI与交互、数据与变量、广播与事件、组件与对象、版本与能力边界、API与接口等专题。

核心文档

研究导航目录 (docs/核心研究/):

适合:需要深入理解引擎底层机制的研究者


5. 项目设计 (docs/项目设计/)

用途:面向项目制作者的系统设计导航,讲解战斗、背包、商店、UI、状态机、任务、交互、存档等系统的拆法与数据放置。

核心文档

专题文档

适合:做项目的玩家、进阶制作者


6. 引擎更新 (docs/引擎更新/)

用途:创游世界引擎更新、版本差异、能力边界与旧资料适用性相关文档。

核心文档

专题研究目录 (docs/引擎更新/专题研究/):

适合:需要了解版本差异和功能演进的制作者


7. OCR资料 (docs/OCR资料/)

用途:创游世界 OCR(截图转文本)资料的中文入口,帮助快速理解原图、OCR 文本、映射表、专题文档之间的关系。

核心文档

映射表目录 (docs/OCR资料/映射表/):

证据链文档

OCR原文

适合:需要查证原始截图和OCR内容的研究者


8. 社区分析 (docs/社区分析/)

用途:社区观察、待验证问题与其他用户解析专题整理。

核心文档

适合:需要了解社区经验和推测性结论的制作者


9. 维护与报告 (docs/维护与报告/)

用途:面向维护者、研究者和 AI 系统的治理入口,帮助快速找到规范、问题清单、研究报告与后续路线图。

核心文档

问题与报告文档

贡献指南

适合:知识库维护者和贡献者


10. 元信息 (docs/元信息/)

用途:术语表、标签体系、文档状态、页面模板等元信息文档。

核心文档

适合:需要统一术语和格式规范的维护者


二、文档命名规范

文件命名原则

  1. 使用中文命名:文件名尽量使用中文,便于中国用户识别和搜索
  2. 避免过长:文件名控制在 20-50 个中文字符以内
  3. 表达主题:文件名应清晰表达文档主题
  4. 避免特殊字符:不要使用 \ / : * ? " < > | 等特殊字符
  5. 统一格式:使用 - 分隔多词,例如 创游世界脚本入门完全指南.md

示例

好的命名不推荐的命名原因
创游世界脚本入门完全指南.md脚本入门.md主题不够明确
广播机制深度解析.mdbroadcast.md不够直观
常见问题与避坑指南.mdFAQ.md不够中文友好

三、Frontmatter 元数据规范

必填字段

yaml
---
title: 页面标题              # 文档标题,用于页面显示和 SEO
description: 用一句话说明这篇文档解决什么问题。  # 用于 SEO 摘要
editor: Azek431             # 编辑者名称
status: 已整理               # 文档状态
difficulty: 入门             # 难度等级
evidence: E1(直接证据)     # 证据等级
updated: 2026-05-16
category: 所属分类           # 所属分类
version: v0.2.x             # 版本号
tags:                       # 标签列表
  - 创游世界
  - 相关标签
---

status 可选值

状态说明
草稿初步起草,内容不完整
整理中正在整理和优化
已结构化结构完整,内容较完善
待验证内容存在待验证部分
已复核已通过复核验证
持续维护长期维护更新

difficulty 可选值

等级说明
入门适合新手阅读
进阶适合有基础的制作者
高级适合进阶用户
研究向适合深入研究

evidence 可选值

等级说明
E1 直接证据官方截图、官方文档等直接证据
E2 OCR/转写证据截图 OCR 或转写内容
E3 归纳结论多来源交叉归纳的结论
E4 社区经验/推测社区观察或经验性推测
资料整理资料整理归纳
待验证内容存在不确定性

四、文档结构标准

推荐结构(长文档)

markdown
# 标题

## 一句话摘要
用 1 到 3 句话说明这篇文档讲什么、解决什么问题。

## 适合谁阅读
说明适合人群。

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

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

[[toc]]

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

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

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

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

## 常见问题
整理读者可能会遇到的问题。

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

## 相关页面
补充站内相关文档链接或建议互链。

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

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

简洁结构(短文档/FAQ)

markdown
# 标题

## 一句话摘要

## 核心结论

## 快速问答

## 相关页面

五、SEO 与 AI 检索优化

标题优化

  1. 标题应包含核心关键词
  2. 标题长度控制在 20-50 字符
  3. 避免标题过于笼统

Description 优化

  1. 用一句话清楚说明页面价值
  2. 包含核心关键词
  3. 控制在 80-150 字符

内容优化

  1. 第一屏能让读者快速知道主题
  2. H2/H3 标题语义清楚
  3. 重要结论短句表达
  4. FAQ 有助于搜索收录
  5. 相关页面形成站内互链

标签优化

  1. tags 不要太泛
  2. 每个文档 5-10 个具体标签
  3. 包含主题关键词和分类关键词

六、如何贡献新文档

贡献步骤

  1. 确定分类:根据文档内容选择合适的分类目录
  2. 检查命名:使用中文命名,避免特殊字符
  3. 编写 frontmatter:包含必填字段
  4. 撰写正文:遵循文档结构标准
  5. 添加相关页面链接:与已有文档建立互链
  6. 提交贡献:通过 GitHub Pull Request 提交

新文档优先级

  1. 新手入门文档
  2. 概念解释文档
  3. 脚本系统教程
  4. UI 与交互教程
  5. 对象与组件教程
  6. 系统设计教程
  7. OCR 资料整理说明
  8. 引擎更新解读
  9. 常见问题 FAQ
  10. 项目结构模板

七、文档维护检查清单

在提交文档前,请检查:

  • [ ] 文件名使用中文,表达主题
  • [ ] frontmatter 包含必填字段
  • [ ] description 用一句话说明页面价值
  • [ ] tags 包含具体关键词(5-10 个)
  • [ ] 标题层级清晰(H1 > H2 > H3)
  • [ ] 有核心结论或摘要
  • [ ] 有相关页面链接
  • [ ] 证据等级标注清楚
  • [ ] 待验证内容标注 [待验证]
  • [ ] 没有编造不存在的功能或 API
  • [ ] 没有把推测写成事实
  • [ ] 没有把社区经验写成官方结论

八、相关页面


待验证问题

  • [待验证] 是否有更多适合 AI 检索的文档结构建议
  • [待验证] 不同分类的最佳文档数量建议

后续优化方向

  • [ ] 补充更多文档示例
  • [ ] 添加截图说明
  • [ ] 完善分类目录结构
  • [ ] 添加贡献流程详细说明

参与维护

发现文档问题?

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

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