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 radio button only in in developer documentation and for a technical audience.
In general, emphasize on the task to be accomplished, rather than how the user should interact with the 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. Refer to a radio button by its label. If you have to use a descriptor, use option or option button.
In general, don’t hyphenate words beginning with re- such as reinstall and reenter unless re- is followed by a proper noun or it is absolutely necessary to avoid confusion.
Don’t use we recommend or WordPress recommends. Instead, use recommended.
Examples
Not recommended: We recommend to use PHPPHPPHP (recursive acronym for PHP: Hypertext Preprocessor) is a widely-used open source general-purpose scripting language that is especially suited for web development and can be embedded into HTML. https://www.php.net/manual/en/preface.php. version 7.4 or greater.
Not recommended: WordPress recommends to use PHPPHPPHP (recursive acronym for PHP: Hypertext Preprocessor) is a widely-used open source general-purpose scripting language that is especially suited for web development and can be embedded into HTML. https://www.php.net/manual/en/preface.php. version 7.4 or greater.
Recommended: It’s recommended to use PHPPHPPHP (recursive acronym for PHP: Hypertext Preprocessor) is a widely-used open source general-purpose scripting language that is especially suited for web development and can be embedded into HTML. https://www.php.net/manual/en/preface.php. version 7.4 or greater.
Use a lowercase x between the numerals in the dimensions, with no space between the numerals and the x. You can also use the multiplication sign (×). Use a space before and after the multiplication sign.
Use to describe closing and reopening a program or app or turning a device off and then immediately back on. Refer to the context of restarting the device.
Don’t use right as a directional term by itself. Instead, use a term such as upper right, lower right, rightmost, or on the right side of. When you use right to modify a noun, insert a hyphen, as in upper-right corner.
Don’t use right-hand as a modifier.
In general, avoid using directional language such as left, right, up, down in instructions to locate UI elements or other content. Directional language proves to be difficult for 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.
