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.
Use to refer to a smaller section or area that is part of the application window. Generally, a pane or view is adjacent to 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 and regions, and cannot be hidden, whereas a window is separate and can be hidden.
OK to use in developer documentation and for a technical audience. Avoid using in user documentation and for a general audience; instead, use clear, delete, or remove.
Not parent – child or parent—child. Don’t use as a synonym for a primary/subordinate relationship.
Use opening parenthesis or closing parenthesis for an individual parenthesis. Don’t use open parenthesis, close parenthesis, beginning parenthesis, ending parenthesis, left parenthesis, or right parenthesis. It’s OK to use parenthesis by itself if it doesn’t matter or it’s clear which parenthesis is being discussed.
OK to use. Avoid using pathname or path name if possible.
Use address or URLURLA specific web address of a website or web page on the Internet, such as a website’s URL www.wordpress.org, not path, to refer to a location on the internet.
In general, use path of, not path to, to refer to the location of a file.
Don’t use please in standard contexts such as procedures, instructions, or tutorials.
Use please only when the user is asked to do something inconvenient, the application or site is to blame for the situation, or when there is an issue with the product.
Example
Tip:Recommended: If the issue persists, please contact your administrator.
OK to use the verb forms port and port to in developer documentation and for a technical audience in the context of portability. Avoid using in user documentation and for a general audience.
Use port as a noun to refer to a location for passing data in and out of a computer or device. Don’t use connector to refer to a port.
For the noun form of port in the context of computer networking, use listen on, not listen to.
In general, don’t hyphenate words beginning with post- such as postdate and postgraduate, unless post- is followed by a proper noun or it is absolutely necessary to avoid confusion.
In general, don’t hyphenate words beginning with pre- such as preexisting and preinstalled, unless pre- is followed by a proper noun or it is absolutely necessary to avoid confusion.
Use only to describe a signal, which might or might not be a message, that an app or the operating system is waiting for the user to take some action. In general, restrict the use of prompt as a noun to the command prompt.
Use as a verb to refer to the act of requesting information or an action from the user.
OK to use in developer documentation and for a technical audience. Avoid using in user documentation and for a general audience; instead, use clear, delete, or remove.
