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 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.
Note:Highlight: Ensure that a pronoun clearly refers to its antecedent.
A pronoun is a word that is used as a substitute for a noun or a noun phrase, which are contextually understood. Pronouns are used so that a particular noun isn’t repeatedly used.
Don’t use gender-specific pronouns unless the person being referred actually uses that gender. If you’re unsure which gender-specific pronoun to use, rewrite the sentence using second person (you).
Use gender-neutral pronouns while particularly avoiding binary pronouns such as he, him, she, her, or renditions like s/he, he/she, or (s)he.
Instead, use they as a gender-neutral pronoun.
First try to rewrite the sentence—for example, by using the plural form, omitting the pronoun, replacing the pronoun with an article, or repeating the noun.
Examples
Warning:Not recommended: Contact the administrator using his or her email address.
Tip:Recommended (Using the plural form): Contact the administrator using their email address.
Tip:Recommended (Omitting the pronoun): Contact the administrator by email address.
Tip:Recommended (Replacing pronoun with article): Contact the administrator using an email address.
Tip:Recommended (Repeating the noun): Contact the administrator using the administrator’s email address.
If revising a sentence isn’t feasible, use they, their, or them as a singular, gender-neutral pronoun.
Warning:Not recommended: Once a visitor submits his or her comment, WordPress follows your preferences and either holds the comment for your approval or posts it immediately.
Tip:Recommended: Once a visitor submits their comment, WordPress follows your preferences and either holds the comment for your approval, or posts it immediately.
Whether used as singular or plural, they always takes the plural verb.
Tip:Recommended: When visitors comment on your blog, they too get cookies stored on their computer.
Be careful while using relative pronouns such as who, that, and which. That and which don’t mean exactly the same thing and cannot be used interchangeably.
Examples
Warning:Not recommended: The folder that is blue can be used.
This sentence describes a specific blue folder that can be used. That introduces a restrictive clause and isn’t preceded by a comma.
Tip:Recommended: The folder, which is blue can be used.
This sentence describes a blue folder from a group of folders can be used. Which introduces a non-restrictive clause and is preceded by a comma.
Use who while referring to people instead of that. The possessive of who, whose can also be used for people, animals, and things. Examples
Warning:Not recommended: Contact the developer that fixed the error.
Tip:Recommended: Contact the developer who fixed the error.
Tip:Recommended: Refer the guide whose elements are cited.
Avoid using pronouns like they for collective nouns. For example, team would take a singular pronoun. Rewrite the sentence using the appropriate pronouns.
Ensure that the pronoun you’re using is referencing its antecedent (the noun that it’s replacing) clearly.
Examples
Warning:Not recommended: Create a new post with the 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. You can see it on the blog page.
Tip:Recommended: Create a new post with the 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, You can see the post on the blog page.
Warning:Not recommended: The WordPress codebase can be accessed using SubversionSVNApache Subversion (often abbreviated SVN, after its command name svn) is a software versioning and revision control system. Software developers use Subversion to maintain current and historical versions of files such as source code, web pages, and documentation. Its goal is to be a mostly compatible successor to the widely used Concurrent Versions System (CVS). WordPress core and the wordpress.org released code are all centrally managed through SVN. https://subversion.apache.org/. and GitGitGit is a free and open source distributed version control system designed to handle everything from small to very large projects with speed and efficiency. Git is easy to learn and has a tiny footprint with lightning fast performance. Most modern plugin and theme development is being done with this version control system. https://git-scm.com/.. Its repository is located at git://develop.git.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//.
Tip:Recommended: The WordPress codebase can be accessed using SubversionSVNApache Subversion (often abbreviated SVN, after its command name svn) is a software versioning and revision control system. Software developers use Subversion to maintain current and historical versions of files such as source code, web pages, and documentation. Its goal is to be a mostly compatible successor to the widely used Concurrent Versions System (CVS). WordPress core and the wordpress.org released code are all centrally managed through SVN. https://subversion.apache.org/. and GitGitGit is a free and open source distributed version control system designed to handle everything from small to very large projects with speed and efficiency. Git is easy to learn and has a tiny footprint with lightning fast performance. Most modern plugin and theme development is being done with this version control system. https://git-scm.com/.. The git repository is located at git://develop.git.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//.
Warning:Not recommended: Toggle this to on.
Tip:Recommended: Toggle this button to on.
Use optional pronouns, such as that and who, to avoid ambiguity and clarify meaning in sentences.
Examples
Warning:Not recommended: Create the new post you want to see on the blog page.
Tip:Recommended: Create the new post that you want to see on the blog page.
Warning:Not recommended: Select the file you want to copy.
Tip:Recommended: Select the file that you want to copy.
