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