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.
OK to use in developer documentation and for a technical audience. Avoid using in user documentation and for a general audience; instead, use stop responding or a contextually relevant term in user documentation.
In general, avoid using directional language such as left, right, up, down in instructions to locate UIUIUI is an acronym for User Interface - the layout of the page the user interacts with. Think ‘how are they doing that’ and less about what they are doing. elements or other content. Directional language proves to be difficult for accessibilityAccessibilityAccessibility (commonly shortened to a11y) refers to the design of products, devices, services, or environments for people with disabilities. The concept of accessible design ensures both “direct access” (i.e. unassisted) and “indirect access” meaning compatibility with a person’s assistive technology (for example, computer screen readers). (https://en.wikipedia.org/wiki/Accessibility) or for localization. People with cognitive impairments, as well as people using assistive technologies such as screen-reading software and might have difficulty interpreting directional language. If a particular UI element or other content is difficult to convey, include a screenshot or illustration.
OK to use in developer documentation and for a technical audience. Avoid using in user documentation and for a general audience. Don’t use flush, flush to, flush left, or flush right to describe text alignment. Instead, use even, left-aligned, or right-aligned, as appropriate.
Use following as an adjective to introduce a table, list, or other content. If following is the last word before what it introduces, follow it with a colon.
Recommended: The following table shows the BlockBlockBlock is the abstract term used to describe units of markup that, composed together, form the content or layout of a webpage using the WordPress editor. The idea combines concepts of what in the past may have achieved with shortcodes, custom HTML, and embed discovery into a single consistent API and user experience.APIAPIAn API or Application Programming Interface is a software intermediary that allows programs to interact with each other and share data in limited, clearly defined ways. reference:
OK to use in developer documentation and for a technical audience. Avoid using in user documentation and for a general audience; instead, use interface, program, app, or a contextually relevant and accurate term.