Welcome to the official home of the WordPress Documentation Team.
This team is responsible for coordinating all documentation initiatives around WordPress, including the handbooks and other general wordsmithing across the WordPress project.
Want to get involved?
Start here to find out more about what we do and how to contribute:
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/
Weekly meetings
Join our discussions of documentation issues here on the blog and on Slack.
Use can to convey permission, to refer to an optional action, or to refer to a possible outcome.
Examples
Recommended: You can also use the slash command to insert a 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..
Recommended: The process can take up to 15 minutes.
Avoid using in the context of features or functionalities of software or hardware. Instead, rewrite the sentence without using the term.
Examples
Not recommended:GutenbergGutenbergThe Gutenberg project is the new Editor Interface for WordPress. The editor improves the process and experience of creating new content, making writing rich content much simpler. It uses ‘blocks’ to add richness rather than shortcodes, custom HTML etc. https://wordpress.org/gutenberg/ has the capability of 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. editing.
Recommended: You can edit blocks with GutenbergGutenbergThe Gutenberg project is the new Editor Interface for WordPress. The editor improves the process and experience of creating new content, making writing rich content much simpler. It uses ‘blocks’ to add richness rather than shortcodes, custom HTML etc. https://wordpress.org/gutenberg/.
Don’t use. Instead, use mobile or mobile phone, or if you’re talking about more than phones, then use mobile device. It’s OK to just use phone by itself when the context is clear.
In general, emphasize on the task to be accomplished, rather than how the user should interact with the UI element. If you have to use a descriptor, use checkbox.
When the environment is presumably a desktop with a mouse, use click to describe the act of selecting most targets such as buttons, links, list items, and radio buttons or initiating an action by briefly pressing and releasing the mouse.
In general, don’t hyphenate words beginning with co- such as coordinate, cooperate, and coexist, unless co- is followed by a proper noun or it is absolutely necessary to avoid confusion.
Two words. It’s OK to use combo box in developer documentation and for a technical audience to describe a box in which the user can enter or select a value.
Avoid using in user documentation and for a general audience. Instead, refer to it as a box.
In general, emphasize on the task to be accomplished, rather than how the user should interact with the UI element. If you have to use a descriptor, use command.
It’s OK to use item or option in the context of commands.
Avoid using whenever possible. Instead, spell out the entire word in a non-code context such as configuration or configuring. It’s OK to use config when referring to, for example, a data structure or a file with that name.
In general, emphasize on the task to be accomplished, rather than how the user should interact with the UI element.
In user documentation, don’t use control when you need to describe the UI element used to set a value on a continuous range of possible values, such as screen brightness or volume. Instead, use slider.
In general, don’t hyphenate words beginning with cyber- such as cybersecurity, cyberspace, and cyberattack, unless cyber- is followed by a proper noun or it is absolutely necessary to avoid confusion.
