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 use to refer to a device, computer, or system that isn’t responding. Instead, use stop responding to describe a program or application which encounters a problem, isn’t responding, and cannot close itself.
Use close to describe the action a program takes to close itself when it has encountered a problem and can’t continue.
Don’t use running head instead of headerHeaderThe header of your site is typically the first thing people will experience. The masthead or header art located across the top of your page is part of the look and feel of your website. It can influence a visitor’s opinion about your content and you/ your organization’s brand. It may also look different on different screen sizes. in the context of content publishing, word-processing, and websites.
It’s OK to use header as a shortened term for file header in developer documentation and for a technical audience.
Don’t use header as an abbreviated term for header file at the beginning of the file which refers to the data libraries, or definitions of variables and data types used by a program.
When the environment is presumably a touch device, use hold and hold the pointer over in a desktop environment, when referring to the action of the user holding or hovering the pointer over a 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. element, but not clicking the element.
Initialism for Hypertext Markup Language. Use uppercase.
Don’t use a filename extension to refer to a type of file. For example, use HTMLHTMLHTML is an acronym for Hyper Text Markup Language. It is a markup language that is used in the development of web pages and websites. file file rather than .html file.
For more information about spelling out abbreviations, see Abbreviations.