大多数包都需要某种形式的解释，以帮助用户获得最佳体验并优化其使用。本页提供了一些关于如何构建信息和格式化文档的技巧。
在包标题之后，给出包及其内容的基本概述。在概述和包内容之后，包括安装说明、系统要求和限制。您还可以提供获取帮助和提供反馈的链接，包括公共论坛或知识库，以及支持联系方式。
在此初步信息之后，您可以提供更深入的工作流程、用户界面描述或示例的目录列表，然后是更高级的主题。最好在最后提供参考页面。
| 部分 | 描述 |
|---|---|
| 概述 | 对包的简要、高层次解释。 |
| 包内容 | 包括您希望用户了解的重要文件的位置。例如，如果这是一个包含按示例组分隔的纹理、模型和材质的示例包，您可能需要指定每个组的文件夹位置。 |
| 安装说明 | 您可以指向官方的Package Manager 安装说明，但如果您有任何特殊的安装要求，例如安装示例，请在此处添加它们。 |
| 需求 | 这是一个添加硬件或软件要求的好地方，包括此包兼容的 Unity 编辑器版本。 |
| 限制 | 如果您的包有任何已知的限制，您可以在此处列出它们。如果没有，或者限制微不足道，请排除此部分。 |
| 工作流程 | 包括用户可以遵循的步骤列表，演示如何使用该功能。您可以包含屏幕截图以帮助描述如何使用该功能。 |
| 高级主题 | 有关您为用户提供的内容的详细信息。如果您不想一开始就用过多的信息压倒用户，这将是理想的选择。 |
| 参考 | 如果您有一个具有许多属性的用户界面，您可以在参考部分描述它们的详细信息。使用表格是提供特定属性描述的好方法。 |
| 示例 | 对于包含示例文件的包，您可以包含有关用户如何在他们的项目和场景场景包含游戏的环境和菜单。将每个独特的场景文件视为一个独特的关卡。在每个场景中，您放置环境、障碍物和装饰，本质上是设计和构建游戏的各个部分。 更多信息 参见 术语表中使用这些示例文件的信息。 |
| 教程 | 如果您想为复杂的过程提供逐步指导，您也可以在这里添加它们。使用分步说明，如果图像可以帮助用户理解，请包含它们。 |
Markdown 是一种轻量级格式，通常用于包中。许多存储库托管服务（如 GitHub 和 Bitbucket）支持 Markdown 用于README文件和文档站点。您可以在包根目录下的Documentation~文件夹中包含一个 Markdown 文件。然后，当用户在 Unity 的 Package Manager 窗口的详细信息面板中单击文档链接时，用户的默认 Markdown 查看器将打开该文件。
您也可以使用自己的网站来托管您的文档。要设置文档链接指向您自己网站的位置，请使用您package.json文件中的documentationUrl属性进行设置。
如果您决定使用 Markdown 来记录您的包，您可以从许多网站找到有关编写 Markdown 文件的信息，包括