Welcome to the official home of the WordPress documentation team.
This team is responsible for coordinating all documentation initiatives around WordPress, including the Codex (moving to HelpHub and DevHub), handbooks, parts of developer.wordpress.orgWordPress.orgThe community site where WordPress code is created and shared by the users. This is where you can download the source code for WordPress core, plugins and themes as well as the central location for community conversations and organization. https://wordpress.org/, admin help, inline docs, and other general wordsmithing across the WordPress project.
Want to get involved?
There are many ways in which you can help the Docs team. Every small contribution counts and helps! You can report an issue or typo you found in the docs, or even help us write new documentation for parts that are still missing. These are some helpful links to find out more about what we do and how to collaborate:
Block Editor Handbook: An overview of documentation contributions 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. Editor / 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/
Documentation Issue Tracker on GitHub: Submit any DevHub/HelpHub/”Doc Team Handbook” Docs-related issue 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.
In general, hyphenate words beginning with e- such as e-learning, e-book, and e-commerce, unless e- is followed by a proper noun or it is absolutely necessary to avoid confusion.
In general, use element for HTML and XML items. HTML 4 elements are known as tags, but the equivalent elements in modern HTML and XML are known as elements.
It’s OK to use emoji to refer to small symbols such as 😃 that represent emoticons, gestures, concepts, objects, and other symbols in documentation with an informal tone.
Use lowercase. Use emoji for both singular and plural forms.
Don’t use emoji in documentation or the UI when there’s a serious problem, failure, or error.
Use regular punctuation with emoji that appear in running text.
Example
Tip:Recommended: Look out for new updates 👀!
Ensure that the meaning of your documentation could be conveyed without emoji. Using emoji may prove to be difficult for accessibility, localization, or for translation. People with cognitive impairments, as well as people using assistive technologies such as screen-reading software and might have difficulty interpreting emoji.
It’s OK to use emoticons to represent an emotion or a facial expression in documentation with an informal tone. Generally, emoticons are created with typographic characters or symbols such as :), :P, or XD.
Don’t use emoticons in documentation or the UI when there’s a serious problem, failure, or error.
Use regular punctuation with emoji that appear in running text.
Example
Tip:Recommended: The bug was fixed :).
Ensure that the meaning of your documentation could be conveyed without emoticons. Using emoticons may prove to be difficult for accessibility, localization, or for translation. People with cognitive impairments, as well as people using assistive technologies such as screen-reading software and might have difficulty interpreting emoticons.
Use enable to refer to turning on an option or feature or making an action possible.
Example
Tip:Recommended: To enable full width, select the Site Width toggle button.
Don’t use enables for things that allow you, or let you, or give you the ability to do something. Instead, rewrite the sentence to emphasize on the task that the user can accomplish. If you have to express ability to do something, use lets you.
Examples
Warning:Not recommended: The get request enables you to retrieve the data.
Tip:Sometimes okay: The get request lets you retrieve the data.
Tip:Recommended: You can retrieve the data using the get request.
Don’t use enabled to mean selected such as while referring to radio buttons or checkboxes.
Examples
Warning:Not recommended: Ensure that your choice is enabled.
Tip:Recommended: Ensure that your choice is selected.
