文档

Unity 引擎

Unity 引擎

记录资源包

创建有助于Users充分利用资源包的文档。
阅读时间4 分钟最后更新于 8 天前

大多数包都需要某种形式的说明来帮助 Users 获得最佳体验并优化其使用。本 Page 就如何构建信息和格式化文档提供了一些提示。

信息的结构

在包的Title之后,提供包其内容的BasicOverview。在Overview和包内容之后,包括安装说明、System要求和限制。您还可以提供获取帮助和提供 Feedback 的链接,包括 public 论坛或知识库以及 Support 联系人。
在此初步信息之后,您可以提供更Depth的工作流程、用户界面描述或样本的目录列表,然后是更高级的主题。最好在接近结束时提供参考页面。

部分

描述

概览包的简要、高关卡说明。
包内容包含您希望用户了解的重要文件的位置。例如,如果这是一个包含样本组分隔的Textures、模型和Materials的样本包,可能需要指定每个组的文件Folder位置。
安装说明您可以指向官方的包管理器安装说明,但如果有任何特殊的安装要求,例如安装样本,请在此处添加。
要求此处适合添加硬件或软件要求,包括包兼容哪些 Unity Editor 版本。
局限性如果您的资源包Any已知限制,可以在此处列表这些限制。否则,或者如果限制微不足道,请排除此部分。
工作流程包含用户可以遵循的步骤列表,演示如何使用该功能。您可以包含屏幕截图来帮助描述如何使用该功能。
高级主题有关向Users提供的内容的Detailed信息。如果不想在前面让用户过多的信息,这是理想的选择。
参考如果您的用户界面有很多Properties,可以在参考部分中描述这些属性的细节信息。使用表是提供指定的属性Descriptions的好方法。
样本对于包含样本文件的包,可以包含ON用户如何在Projects和场景中使用这些样本文件的Detailed信息。
教程如果要提供复杂过程的演练,也可以在此处添加。使用分步步骤说明并包含有助于用户理解的图像。

文档 Format

Markdown 是包中常用的轻量级 Format。许多代码仓库托管 Services(例如 GitHub 和 Bitbucket)支持
README
文件和文档站点的 Markdown。您可以在包根目录下的
Documentation~
Folder 中包含 Markdown 文件。然后,当用户单击 Unity 包管理器窗口的细节面板中的文档 Link 时,用户的默认 Markdown 查看器将打开文件。
您还可以使用自己的网站托管文档。要将文档 Link 的位置设置为指向您自己的网站,请使用
package.json
文件中的 documentationUrl 属性进行设置。
如果您决定使用 Markdown 来记录资包,可以从许多站点查找有关编写 Markdown 文件的信息,包括: