Quick reference guide for Unity documentation
The Unity Style Guide provides detailed guidelines for creating content that is clear, concise, consistent, accessible, and usable. For a summary of the main points, refer to the following quick reference guide.
Guideline | Incorrect | Correct |
---|---|---|
Use US English spelling. To confirm spelling, refer to the Merriam-Webster dictionary. |
|
|
Use short, simple sentences. For concept or reference pages, use less than 25 words per sentence. For task pages, use less than 20 words per sentence. | Complex, ambiguous, or unclear English is more difficult to translate, making localization more time-consuming and also more costly and difficult to understand. | Simple, clear, and easy-to-understand English is faster and less costly to translate. |
Use articles (include āaā, āanā, or ātheā). | Open Unity Editor. | Open the Unity Editor. |
Use one precise action per sequential step. | Check the power and switch settings. |
|
Limit each sentence to one thought or action. | Unity performs the calculations for baked lights in the Unity Editor and saves the results to disk as lighting data in a process called baking, then at runtime, Unity loads the baked lighting data, and uses it to light the scene. | Unity performs the calculations for baked lights in the Unity Editor. The Editor saves the results to disk as lighting data. This process is called baking. At runtime, Unity loads the baked lighting data, and uses it to light the scene. |
Avoid slang, idioms, sporting references, and humor. Instead, use descriptive names. |
|
|
Spell out abbreviations and acronyms, and define them where necessary. | LOD is a technique that reduces the number of graphical operations that Unity requires to render distant meshes. | Level of detail (LOD) is a technique that reduces the number of graphical operations that Unity requires to render distant meshes. |
Use consistent terminology. |
|
|
Avoid ambiguous words or terms. Assign only one meaning per word. |
|
|
Use bulleted lists to present information in a way that users can scan. If you have several items listed in a paragraph use a bulleted list. | There are three render pipelines: Universal Render Pipeline (URP), High Definition Render Pipeline (HDRP), and Built-in Render Pipeline. | There are three render pipelines:
|
Use tables to present information in a way that users can scan, for example, use tables on reference pages that describe multiple settings/options. | Refer to Tables for detailed guidance. | Refer to Tables for detailed guidance. |
Avoid symbols and icons. Many, such as the check and cross marks, have different meanings in different cultures. |
|
|
Combine multiple unnecessary words into single-word equivalents. |
|
|
Use active voice; give direct instructions. | A window is opened. |
|
Be explicit and avoid ambiguity. Check for ambiguity if you use the following:
|
|
|
Use punctuation appropriately and consistently. | Choose from two types of light:
| Choose from two types of light:
|
Avoid over-modified nouns. | The staffing level authorization permission reassessment process should result in major improvements. | To achieve major improvements, the process reassesses the permissions that we need for staffing levels. |
Avoid gerunds (ā¦ing verbs). | Importing a GameObject | Import a GameObject |
Use the Oxford comma | The buttons are blue, red, green and pink. | The buttons are blue, red, green, and pink. |