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.
Don’t use icon to describe options that appear on toolbars, menus, or other 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 in a window. For options that have graphics rather than text labels, use the most descriptive term available, such as button, box, or checkbox.
If a graphic is enclosed in a rectangular border, then refer to it as a button. If it is not enclosed in a rectangular border, and doesn’t initiate an action when clicked, then refer to it as an icon.
If an icon doesn’t have any label or name, and you have to use a descriptor, use a contextually relevant term. Describe the icon’s appearance or function and include an inline graphic of the icon. Don’t enclose the icon in parentheses. Use lowercase. It’s OK to use the word icon in discussions about the icon itself.
Use if to indicate a condition. Use whether to indicate when two outcomes are possible.
If you can affix the words or not in a clause, use whether rather than if.
Examples
Warning:Not recommended: The is_plugin_active() function determines if a pluginPluginA plugin is a piece of software containing a group of functions that can be added to a WordPress website. They can extend functionality or add new features to your WordPress websites. WordPress plugins are written in the PHP programming language and integrate seamlessly with WordPress. These can be free in the WordPress.org Plugin Directory https://wordpress.org/plugins/ or can be cost-based plugin from a third-party is active.
Tip:Recommended: The is_plugin_active() function determines whether a pluginPluginA plugin is a piece of software containing a group of functions that can be added to a WordPress website. They can extend functionality or add new features to your WordPress websites. WordPress plugins are written in the PHP programming language and integrate seamlessly with WordPress. These can be free in the WordPress.org Plugin Directory https://wordpress.org/plugins/ or can be cost-based plugin from a third-party is active (or not).
Use in to when in is part of the verb. Use into to refer to a movement or action taking place inside something, or expressing a change of state.
Examples
Warning:Not recommended: Log into your computer.
Tip:Recommended: Log in to your computer.
Tip:Recommended: You can import content into your site from another WordPress site using the WordPress Import tool.
Tip:Recommended: Split the columns into one-thirds using the column 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..
Initialism for Input/Output. Use uppercase and note the punctuation.
OK to use in developer documentation and for a technical audience. Always spell out on the first mention. It’s OK to abbreviate as I/O for subsequent instances.
Avoid using in user documentation and for a general audience.
For more information about spelling out abbreviations, see Abbreviations.
