Documentation Issue Tracker on GitHub: Submit any Documentation Team-related issues on GitHubGitHubGitHub is a website that offers online implementation of git repositories that can easily be shared, copied and modified by other developers. Public repositories are free to host, private repositories require a paid subscription. GitHub introduced the concept of the ‘pull request’ where code changes done in branches by contributors can be reviewed and discussed before being merged be the repository owner. https://github.com/
Join our discussions of documentation issues here on the blog and on Slack.
Don’t hyphenate a predicate adjective unless specifically mentioned in the Word list and usage dictionary or otherwise. An adjective predicate is an adjective that modifies the subject of the sentence. The adjective and the subject are connected by a linking verb.
Warning:Not recommended: The image needs to be high-resolution.
Tip:Recommended: The image needs to be high resolution.
Warning:Not recommended: The document is up-to-date.
Use hyphenated compound modifiers before a noun. A compound modifier (also known as a noun modifier) precede and modify the noun as a unit. Only hyphenate two or more words that precede and modify the noun as a unit of it doesn’t result in undue confusion. Don’t hyphenate a compound modifier when you use it after a noun.
Warning:Not recommended: Don’t use the recently deprecated tool.
Tip:Recommended: Don’t use the recently-deprecated tool.
Warning:Not recommended: The high capacity website hosting is impressive.
Tip:Recommended: The high-capacity website hosting is impressive.
Hyphenate two or more words that precede and modify the noun:
If one of the words is a past or present participle (a verb ending in -ing or -ed being used as an adjective or noun).
For example, well-formatted text, mind-stimulating blog, or left-aligned paragraph.
If the compound modifier is a number or a single letter with a noun or participle.
For example, three-pronged approach, Cartesian x-axis, or 4-sided quadrilateral.
In compound words that precede and modify a noun as a unit, don’t hyphenate:
The word very when it precedes another modifier.
For example, very high capacity or very fast storage.
Jump to the thirty-second page in the user manual.
Split the columns into one-thirds using the column block.
En dashes (–) are generally used to indicate a range of numbers, the minus sign, or negative numbers. Although you can use en dashes for these purposes, you can also use hyphens or the word to for numerical ranges. Use an en dash indicate a range of numbers such as values or dates. Don’t add spaces before and after the en dash or the hyphen. Use an en dash instead of a hyphen in a compound adjective when the compound adjective includes an open compound.
Don’t use suspended compound modifiers that have a common base. You can either spell out the entire phrase, or leave a space after hyphen and leave out the base. Don’t form suspended compound modifiers from one-word adjectives.
Warning:Not recommended: You can use either left, right, or center-aligned text formatting.
Tip:Recommended: You can use either left-aligned, right-aligned, or center-aligned text formatting.
Tip:Recommended: You can use either left-, right-, or center-aligned text formatting.