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.
Highlight: Maintain consistent type and text formatting.
Consistent text formatting and type treatment is a principal factor in great documentation and design. The intuitive use of text formatting, color combinations, alignment, spacing, and punctuation enables simplicity and improves readability for the reader.
Formatting text uniformly by utilizing distinct design and structures such as that in headings, tables, lists, URLs, and code examples helps distinguish information easily, while also making it easier for scannable and accessible documentation.
Text can be highlighted to distinguish itself from other text using the following text-formatting conventions:
Use bold formatting, <b> in HTML or ** in Markdown for UI elements and at the beginning of notices.
Although a double underscore (__) can be used for bold formatting in Markdown, it can be difficult to distinguish in a text editor. Preferably, use double asterisks (**) for bold formatting in Markdown.
Use italic formatting, <i> in HTML or _ in Markdown, when drawing attention to a specific word or phrase, such as when defining or introducing key terms or using words as words. You can also use a single asterisk (*) for italic formatting in Markdown.
Do not underline.
Do not use strikethrough.
Use <code> in HTML or ` in Markdown to apply a monospace font and other styling to code in text, inline code, and user input.
Use <pre> in HTML or ``` in Markdown for code examples or other blocks of code.
Clear, legible, as well as aesthetically pleasing typography is one of the primary features in visually appealing content.
In general, use sentence-case capitalization and avoid other forms of capitalization such as all-uppercase, all-lowercase, or title case.
For more information, see Capitalization.
Use left alignment for text. This ensures an even left margin with a irregular right margin- improving document structure.
Avoid center-aligned text.
Ensure adequate and consistent line spacing – which is the amount of vertical space between two lines of text in a text body. If your site’s design determines the line spacing, don’t change it. Don’t reduce line spacing to fit more text or content; rewrite or edit the text instead.