This style guide is primarily for use with authoring documentation.
If you have questions that aren't explicitly covered by this guide, consult the following third-party references:
|Type of guidance||Third-party reference|
|Style - nontechnical||The Chicago Manual of Style|
|Style - technical||Microsoft Writing Style Guide|
The following are tools that you can use to edit your writing. However, take the suggestions provided with a grain of salt.
Below summarizes the text-formatting conventions you should follow.
Use bold formatting when referring to UI elements.
Use italics for:
Use code font for:
Use code blocks for code samples and other blocks of code. Be sure to indicate the language your using to apply the proper syntax highlighting.
This is a codeblock.
For code that you want users to enter via a command-line interface, use
Do not use the ampersand (&) as a shorthand for and unless you're referring to a UI element or the name of something that uses &.
You can use the symbol
~ in place of the word approximately.
When referring to UI elements, including the names for buttons, menus, dialogs, and anything that has a name visible to the user, use bold font.
Example: On the Environment Overview page, click Configure SSH.
Don't use code font for UI elements unless it is rendered based on previously entered
text. For example, if you tell the user to provide the environment name as
myEnvironment, then use both bold and cold font when referring to the name.
When writing out instructions that involve UI elements, both of the following options are acceptable:
Below summarizes the guidelines regarding how Coder terms should be used.
The only Coder-specific terms that should be capitalized are the names of products (e.g., Coder).
The exception is code-server, which is always lowercase. If it appears at the beginning of the sentence, rewrite the sentence to avoid this usage.
In general, we do not capitalize the names of features (unless the situation calls for it, such as the word appearing at the beginning of a sentence):
We also do not capitalize the names of user roles: