知识库结构与维护指南
一句话摘要
本文档说明创游世界知识库的目录结构、文档分类规则、维护流程与贡献方式,帮助你快速理解资料库的组织方式并参与维护。
适合谁阅读
- 想参与资料库维护的贡献者
- 想知道资料库组织方式的普通用户
- 需要查找特定主题但不知道从哪入手的访客
- 需要理解文档分类规则的 AI 检索系统
你将学到什么
- 知识库的十大分类目录及其用途
- 文档的命名规范和 frontmatter 要求
- 文档状态分级与证据等级标准
- 如何贡献新文档或优化已有文档
- 文档的 SEO 与 AI 检索优化方法
一、知识库十大分类目录
1. 总索引与导航 (docs/总索引与导航/)
用途:面向新手的入口页面和学习路线规划。
核心文档:
- 新手阅读路线 - 从零到项目的完整学习路径
- 新手入门指南 - 编辑器基础与核心概念
- 快速入门索引 - 快速定位入口
- 创游世界知识库总导航 - 整个知识库的中文主入口
- [docs 目录分类对照表](./docs 目录分类对照表.md) - 目录结构说明
适合:第一次使用知识库的用户
2. 教程资料 (docs/教程资料/)
用途:收录创游世界的教程类资料,包括官方教程索引、学习路线、专题研究、B站视频资源等。
核心文档:
- 官方教程知识索引 - 按主题分类整理的官方教程索引
- 创游世界新手常见问题速查 - 高频问题快问快答
- 常见问题与避坑指南 - 常见问题与避坑建议
专题研究目录 (docs/教程资料/专题研究/):
- 创游世界学习路线图 - 从零到项目上线的完整学习路径规划
- 创游世界对象_素材_组件_脚本关系总图 - 核心概念关系图
- 创游世界脚本入门完全指南 - 零基础脚本入门
- 创游世界组件系统完全指南 - 组件系统完全指南
- 广播机制深度解析 - 广播机制详解
- UI系统与切换机制解析 - UI分类与切换
- 素材系统与组件挂载解析 - 素材系统详解
- 素材实例化与地图物体关系解析 - 模板与实例关系
适合:所有学习阶段的用户
3. 脚本系统 (docs/脚本系统/)
用途:脚本系统的核心文档和专题研究,涵盖脚本界面、积木能力、数据流、API、组件体系与实战架构。
核心文档:
- 脚本界面与积木知识索引 - 脚本编辑器与积木块总览
- 创游世界广播命名规范与最佳实践 - 广播命名规范
专题研究目录 (docs/脚本系统/专题研究/):
入门系列
- 创游世界脚本入门完全指南 - 脚本入门完全指南
- 创游世界新手常见卡点与避坑清单 - 新手常见问题
- 创游世界脚本实战架构入门 - 实战架构入门
进阶系列
- 脚本作用域与数据流深度研究 - 数据分层研究
- 脚本组件体系与能力分层深度研究 - 能力分层研究
- 自定义组件深度解析 - 自定义组件设计
- 系统级脚本能力解析 - 系统级能力
- 创游世界 API 整理 - API总览
- 组件添加界面深度解析 - 组件添加界面详解
项目架构系列
- 创游世界项目结构模板 - 项目模板
- 创游世界广播驱动项目结构实战 - 广播驱动架构
- 创游世界UI数据同步架构 - UI与真值解耦
系统设计系列
- 创游世界战斗系统设计入门 - 战斗系统
- 创游世界背包与货币系统设计入门 - 背包/货币
- 创游世界任务与事件系统设计入门 - 任务系统
- 创游世界交互系统设计入门 - 交互系统
- 创游世界动作状态机入门 - 状态机
- 创游世界存档与云变量设计入门 - 存档设计
- 创游世界格子UI与列表系统深度解析 - 列表系统
适合:进阶用户、项目制作者
4. 核心研究 (docs/核心研究/)
用途:核心机制研究的聚合导航,涵盖脚本系统、UI与交互、数据与变量、广播与事件、组件与对象、版本与能力边界、API与接口等专题。
核心文档:
- 核心研究导航 - 核心研究总入口
- 核心概念速查手册 - 核心概念速查
- 创游世界数据分层模型 - 数据分层模型
- 创游世界数据类型完全指南 - 数据类型详解
- 创游世界变量与作用域完全指南 - 变量作用域详解
- 创游世界碰撞与物理系统入门 - 物理系统
- 创游世界联机系统入门 - 联机系统
- 创游世界广播机制完全指南 - 广播机制完整指南
研究导航目录 (docs/核心研究/):
- 脚本系统研究导航 - 脚本系统研究入口
- UI与交互研究导航 - UI与交互研究入口
- 数据、变量与作用域导航 - 数据系统研究入口
- 广播与事件机制导航 - 事件驱动研究入口
- 组件与对象系统导航 - 组件体系研究入口
- 版本与能力边界导航 - 版本演进研究入口
- API与脚本接口导航 - API研究入口
- 专题研究导航 - 专题研究总览
适合:需要深入理解引擎底层机制的研究者
5. 项目设计 (docs/项目设计/)
用途:面向项目制作者的系统设计导航,讲解战斗、背包、商店、UI、状态机、任务、交互、存档等系统的拆法与数据放置。
核心文档:
- 项目设计导航 - 项目设计总入口
- 项目结构与架构导航 - 项目结构入口
- 系统设计专题导航 - 系统设计入口
- 商店系统专题导航 - 商店系统入口
- 多地图与场景切换导航 - 地图切换入口
- 教程引导与新手流程导航 - 教程引导入口
专题文档:
- 创游世界实战项目模板 - 完整项目模板
- 创游世界商店系统实战设计指南 - 商店系统完整指南
- 创游世界多地图与场景切换设计指南 - 多地图设计指南
- 创游世界地图设计基础指南 - 地图设计基础
- 创游世界数据持久化与存档设计指南 - 存档设计指南
- 创游世界项目维护与代码组织规范 - 项目维护规范
适合:做项目的玩家、进阶制作者
6. 引擎更新 (docs/引擎更新/)
用途:创游世界引擎更新、版本差异、能力边界与旧资料适用性相关文档。
核心文档:
- 引擎更新知识索引 - 版本演进总览
- 创游世界引擎更新演进简史 - 引擎演进简史
专题研究目录 (docs/引擎更新/专题研究/):
- 4.54.0 数据类型与脚本能力升级解析 - 新版本特性
- 联机UI演进专题 - 联机UI演进
适合:需要了解版本差异和功能演进的制作者
7. OCR资料 (docs/OCR资料/)
用途:创游世界 OCR(截图转文本)资料的中文入口,帮助快速理解原图、OCR 文本、映射表、专题文档之间的关系。
核心文档:
- OCR资料导航 - OCR总入口
- OCR 资料总览与完整化现状 - OCR整体状态
- OCR 完整化总表 - 完整度总览
映射表目录 (docs/OCR资料/映射表/):
- OCR 图片编号映射表 - 编号与主题映射
证据链文档:
- OCR 证据链说明 - 证据链构建说明
- OCR 证据使用规范 - 证据使用规范
- OCR 专题回链示例 - 回链示例
- OCR 状态词与回链规范 - 状态词规范
- OCR 未识别与残缺清单 - 未识别清单
OCR原文:
- 基础写脚本界面截图转文本 - 脚本界面OCR
- 官方教程截图转文本索引 - 官方教程OCR
- 引擎更新截图转文本 - 引擎更新OCR
适合:需要查证原始截图和OCR内容的研究者
8. 社区分析 (docs/社区分析/)
用途:社区观察、待验证问题与其他用户解析专题整理。
核心文档:
- 其他用户解析专题整理 - 社区观察整理
- 待验证问题清单 - 待验证问题
适合:需要了解社区经验和推测性结论的制作者
9. 维护与报告 (docs/维护与报告/)
用途:面向维护者、研究者和 AI 系统的治理入口,帮助快速找到规范、问题清单、研究报告与后续路线图。
核心文档:
- 维护与报告导航 - 维护总入口
- 更新日志入口导航 - 更新日志入口
- 资料规范与状态总览 - 资料规范总览
- 文档状态分级规则 - 状态分级
- 维护检查清单 - 维护检查
- 维护流程说明 - 维护流程
- 合规与版权声明 - 版权声明
问题与报告文档:
- 待验证问题清单 - 待验证问题
- 后续研究路线图 - 研究路线
- 知识库深度优化报告 - 优化报告
- AI自动文档建设报告 - AI建设报告
- 站点部署与运维方案 - 部署运维
贡献指南:
- 社区贡献与维护指南 - 贡献指南
适合:知识库维护者和贡献者
10. 元信息 (docs/元信息/)
用途:术语表、标签体系、文档状态、页面模板等元信息文档。
核心文档:
- 元信息导航 - 元信息总入口
- 创游世界术语表 - 术语统一表
- 知识标签体系总表 - 标签体系
- 知识条目统一元数据规范 - 元数据规范
- 知识库文档状态总表 - 文档状态总表
- 创游世界资料库深入研究报告 - 深入研究报告
- 页面模板 - 页面模板
适合:需要统一术语和格式规范的维护者
二、文档命名规范
文件命名原则
- 使用中文命名:文件名尽量使用中文,便于中国用户识别和搜索
- 避免过长:文件名控制在 20-50 个中文字符以内
- 表达主题:文件名应清晰表达文档主题
- 避免特殊字符:不要使用
\ / : * ? " < > |等特殊字符 - 统一格式:使用
-分隔多词,例如创游世界脚本入门完全指南.md
示例
| 好的命名 | 不推荐的命名 | 原因 |
|---|---|---|
创游世界脚本入门完全指南.md | 脚本入门.md | 主题不够明确 |
广播机制深度解析.md | broadcast.md | 不够直观 |
常见问题与避坑指南.md | FAQ.md | 不够中文友好 |
三、Frontmatter 元数据规范
必填字段
---
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 社区经验/推测 | 社区观察或经验性推测 |
| 资料整理 | 资料整理归纳 |
| 待验证 | 内容存在不确定性 |
四、文档结构标准
推荐结构(长文档)
# 标题
## 一句话摘要
用 1 到 3 句话说明这篇文档讲什么、解决什么问题。
## 适合谁阅读
说明适合人群。
## 你将学到什么
用列表说明读者读完能获得什么。
## 核心结论
先给重要结论,不要绕弯子。
[[toc]]
## 背景说明
解释为什么这个主题值得单独整理。
## 基础概念
用新手能理解的语言解释相关概念。
## 详细解析
结合资料库已有内容进行深入说明。
## 示例说明
提供场景、操作思路、伪代码、项目设计例子。
## 常见问题
整理读者可能会遇到的问题。
## 注意事项
标出容易误解、容易踩坑、需要验证的地方。
## 相关页面
补充站内相关文档链接或建议互链。
## 待验证问题
列出不能确定的内容。
## 后续优化方向
说明这篇文档以后还能补什么。简洁结构(短文档/FAQ)
# 标题
## 一句话摘要
## 核心结论
## 快速问答
## 相关页面五、SEO 与 AI 检索优化
标题优化
- 标题应包含核心关键词
- 标题长度控制在 20-50 字符
- 避免标题过于笼统
Description 优化
- 用一句话清楚说明页面价值
- 包含核心关键词
- 控制在 80-150 字符
内容优化
- 第一屏能让读者快速知道主题
- H2/H3 标题语义清楚
- 重要结论短句表达
- FAQ 有助于搜索收录
- 相关页面形成站内互链
标签优化
- tags 不要太泛
- 每个文档 5-10 个具体标签
- 包含主题关键词和分类关键词
六、如何贡献新文档
贡献步骤
- 确定分类:根据文档内容选择合适的分类目录
- 检查命名:使用中文命名,避免特殊字符
- 编写 frontmatter:包含必填字段
- 撰写正文:遵循文档结构标准
- 添加相关页面链接:与已有文档建立互链
- 提交贡献:通过 GitHub Pull Request 提交
新文档优先级
- 新手入门文档
- 概念解释文档
- 脚本系统教程
- UI 与交互教程
- 对象与组件教程
- 系统设计教程
- OCR 资料整理说明
- 引擎更新解读
- 常见问题 FAQ
- 项目结构模板
七、文档维护检查清单
在提交文档前,请检查:
- [ ] 文件名使用中文,表达主题
- [ ] frontmatter 包含必填字段
- [ ] description 用一句话说明页面价值
- [ ] tags 包含具体关键词(5-10 个)
- [ ] 标题层级清晰(H1 > H2 > H3)
- [ ] 有核心结论或摘要
- [ ] 有相关页面链接
- [ ] 证据等级标注清楚
- [ ] 待验证内容标注
[待验证] - [ ] 没有编造不存在的功能或 API
- [ ] 没有把推测写成事实
- [ ] 没有把社区经验写成官方结论
八、相关页面
待验证问题
[待验证]是否有更多适合 AI 检索的文档结构建议[待验证]不同分类的最佳文档数量建议
后续优化方向
- [ ] 补充更多文档示例
- [ ] 添加截图说明
- [ ] 完善分类目录结构
- [ ] 添加贡献流程详细说明
