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.
As a noun, use to refer to tabs that show a separate view or subpages on a webpage, dialog box, browser, or menu. For other uses of the term, clarify the meaning with a descriptor, such as the Tab key, a tab character, a tab stop, or a tab mark on the ruler.
Use tap to describe selecting, opening, or enabling targets such as buttons, links, list items, or other elements with a finger or pen by tapping it once. Don’t use tap on.
Use double-tap to describe selecting, opening, or enabling targets such as buttons, links, list items, or other elements with a finger or pen by tapping it twice in quick succession. Hyphenate double-tap. Don’t use double-tap on.
Don’t use, especially in reference to people. Instead, use intended for, looking for, focused on, and interacting with. Instead of using target file, refer to the specific file or folder, or use destination file or destination folder.
Examples
Warning:Not recommended: Move the files to the target folder.
Tip:Recommended: Move the files to the wp-contents folder.
Use to introduce a restrictive or defining clause; clauses beginning with that are generally not set off with commas.
Example
Tip: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/ is the latest 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. editor that is widely used.
Insert a noun after that for clarity, whenever possible. It is acceptable to omit the noun in UI, tables, or headings where space is limited. If you aren’t sure what noun that refers to, then consider rephrasing.
Use they, their, them as gender-neutral pronouns when referring to people of unspecified gender. Don’t use he, him, she, her, or renditions like s/he, he/she, or (s)he for people of unspecified gender.
Insert a noun after this for clarity, whenever possible. It is acceptable to omit the noun in UI, tables, or headings where space is limited. If you aren’t sure what noun this refers to, then consider rephrasing.
As a verb, it is OK to use toggle in developer documentation and for a technical audience. Avoid using in user documentation and for a general audience; instead use turn on or turn off, switch between, enable, or relevant terminology depending on the context.
OK to use as a noun or an adjective, as in toggle button or toggle switch. A toggle button is a UI element that switches back and forth between on and off options or states.
When the environment is presumably a touch device, use touch and hold to describe selecting, opening, or enabling targets such as buttons, links, list items, or other elements with a finger or pen by tapping and holding it stationary until a result occurs. Don’t use touch and hold on.
Avoid using; instead, use a detailed and accurate term whenever possible.
Examples
Warning:Not recommended: Traditionally, pages also do not make use of categories and tags like posts do.
Tip:Recommended: Conventionally, pages also do not make use of categories and tags like posts do.
Warning:Not recommended: If you want to use the theme for a traditional blog, the centered content column and considered typography makes it perfect for that as well.
Tip:Recommended: If you want to use the theme for a straightforward blog, the centered content column and considered typography makes it perfect for that as well.
Warning:Not recommended: Unlike a traditional system cron that schedules tasks for specific times, WP-Cron uses intervals to simulate a system cron.
Tip:Recommended: Unlike a system cron that schedules tasks for specific times (e.g. “every hour at 5 minutes past the hour”), WP-Cron uses intervals to simulate a system cron.
Use to describe something that is standard or expected under normal circumstances. Avoid using as the first word of a sentence, as the meaning of the content can be misunderstood.
