风格指南
本页说明了如何编写清晰、简洁、友好的文档。它总结了 Google 免费课程技术写作（CC BY 4.0）的 内容，并推荐如何将其应用于 VRChat 的创作文档。
在向 VRChat 创作文档贡献之前，你应该阅读本页。
VRChat 创作文档的编写早于本风格指南。如果你想对任何页面提出改进建议，请提交 pull request。
术语和缩写
Unity、VRChat 和 VRChat SDK 包含读者可能不熟悉的术语。在编写文档时，请明确这些术语。
- 如果引入新术语，请解释它。如果术语已存在，提供解释该术语的页面链接。
- 例如："Marketplace"选项卡允许你查看所有使用创作者经济的 VRChat 世界。
- 尽量一致地使用术语。不要在同一个术语的不同变体之间切换。
- 例如："GameObject"和"game object"。
- 对于非 VRChat 或 SDK 特有的术语使用小写，即使它们在 VRChat 中有特定含义。
- 例如：avatar（头像）、world（世界）、creator（创作者）。
- 对于 VRChat 或 SDK 特有的术语大写，即使它们包含上述单词之一。
- 例如：Avatars SDK、Worlds SDK、VRChat、Creator Economy（创作者经济）。
你可以对文档中频繁使用的术语使用缩写。在文档中首次使用缩写时，应定义它。例如：
- Software Development Kit (SDK)
- VRChat Creator Companion (VCC)
- Creator Economy (CE)
不要定义不常用的缩写——直接使用完整术语即可。
主动语态
大多数文档应使用主动语态编写，而不是被动语态。下表展示了主动语态如何让句子更清晰易读：
| 被动语态 | 主动语态 |
|---|---|
| Avatars can be created by anyone. | Anyone can create avatars. |
| Products are contained in listings. | Listings contain products. |
主动语态还有助于突出句子中的执行者。被动语态有时会省略执行者：
| 被动语态 | 执行者是谁？ | 主动语态 |
|---|---|---|
| Wait for your content to be uploaded. | SDK | Wait for the SDK to upload your content. |
| This option must be enabled in the inspector. | 你（读者） | You must enable this option in the inspector. |
清晰的句子
使用强动词和主语来编写更清晰的句子。强动词能提高句子的清晰度，吸引读者。避免使用弱化、不精确或通用的动词。例如：
| 弱动词 | 弱动词示例 | 强动词示例 |
|---|---|---|
| Be | Be careful not to exceed... | Ensure that you don't exceed... |
| Occur | The issue occurs when upgrading the SDK. | Upgrading the SDK causes this issue. |
| Happen | Avatar performance issues happen if... | Avatars reduce performance if... |
"be"的变体（is、are、was、were...）有时是最佳选择。你不必总是替换它们——但花时间考虑替代方案是值得的。
以"There is"开头的句子结合了弱主语（"There"）和弱动词（"is"）。通过用强主语和动词替换"There is"来改进句子：
| 包含 there is / are 的句子 | 包含强动词和主语的句子 |
|---|---|
| There is an auto-layout option that arranges your windows automatically. | The auto-layout option arranges your windows automatically. |
| There are many ways to detect the VRChat SDK. | You can detect the VRChat SDK in many ways. |
| There is no guarantee the master player will respond. | The master player may not respond. |
简短的句子
简短的句子通常比长句更容易阅读、理解和维护。
- 每个句子专注于一个想法。如果句子包含多个想法，将其拆分为多个句子。
- 在长句中使用连词"or"时，考虑将其转换为项目符号列表。
- 用简洁的词语替换多余的短语。例如，用"now"替换"at this point in time"。
列表和表格
列表和表格可以让文档更容易理解。
- 用一句话介绍每个列表和表格，告诉读者它代表什么。
- 每个条目的首字母大写。如果使用句子，请添加标点符号。
- 条目之间应相互"关联"或属于相似类别。
下表说明了如何选择应使用的列表类型：
| 列表类型 | 示例 | 描述 |
|---|---|---|
| 项目符号列表 |
| 用于无序项目。更改顺序不会改变列表的含义。 |
| 编号列表 |
| 用于有序项目。更改顺序会改变列表的含义。 每个条目以 祈使动词开头，例如"download"。 |
Markdown 语法不支持表格内的换行或列表。你可以使用 HTML 标签如 <br/>、<ul> 和 <li> 替代，但这通常会影响表格的格式。
段落
段落通过将复杂想法分解成更小的主题来帮助读者。以下是组织好段落的方法：
- 写一个出色的开篇句，确立该段落的主题。
- 每个段落专注于一个主题。移动或删除与当前主题无关的句子。
- 避免过长的段落。大段文字会让读者望而生畏。
- 避免过短的段落。将它们合并或转为列表。
受众
在编写文档时，要考虑你的受众是谁以及你希望他们学到什么。以下是一些几乎 可以始终成立的假设：
- 你的受众可以在 Steam、Oculus、Pico、Android 或 iOS 上访问 VRChat。
- 你的受众了解基本的 VRChat 概念，如玩家、头像、世界、好友和虚拟现实。
- 你的受众使用英语，但可能不是母语者。
- 你的受众知道如何使用 Creator Companion 创建 VRChat 世界或头像的 Unity 项目。
VRChat 创作文档拥有广泛的受众。有些页面面向需要入门指南的初学者，其他页面则面向已经熟悉基础知识的专家。如果你的受众已经了解某些内容，则无需重复。例如：