Content guidelines

这篇文档将会介绍 Gandi IDE Documentation 的目录结构以及其中包含的内容。

Gandi IDE 的文档分为五大类。

关于引擎与文档的基础信息。

其中的文档会介绍 Gandi IDE 的基础信息、文档的介绍和使用方式，以及一些常见问题。

这部分的目的是提供一些基础信息，并且让打开文档的用户能够根据他们的目的快速找到对应的文档。

通常不需要在 ABOUT 中新增文档，尽量保持这里的信息足够精简，避免用户产生过大的认知负担。

针对新接触引擎的用户快速上手的模块，主要包含 3 个部分：

对编辑器的详细介绍，包括编辑器界面，创作中的一些重要概念，和 Cocrea 的介绍等。

从进入编辑器创作，到发布作品，编辑作品页面的过程中主要操作的步骤引导以及对应的注意事项。

这里不包含提高创作效率的高级功能，这部分功能在 MANUAL 中介绍。

使用 Gandi IDE 从头开始完成一个简单游戏的完整教程，帮助新人快速上手。

完整详细的操作手册，所有的编辑器功能以及关于语句的解释都可以在这里找到，还会包含一些 Best Practices 的 step-by-step 引导。包含 4 个部分：

编辑器的所有功能的使用说明。

Cocrea 的所有功能的使用说明。

所有编程语句的积木文档，包含所有扩展的使用说明。

基于创作场景的最佳实践合集，大部分以 Step-by-step guide 的形式呈现。

提供给社群用户，基于 Gandi IDE 与文档为社群做贡献的方式与说明。主要包含 2 个部分：

参与 Gandi IDE 开发及文档创作的相关标准与原则，目的是保证相关内容的质量与统一性。

提供给社群成员的，为社群做贡献的引导。

关于社群以及社群提供的资源的信息汇总。

未包含在以上分类的文章，例如开发团队在设计新功能时的思考等。可以被引用在文档中。