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.
OK to use in developer documentation and for a technical audience. Avoid using in user documentation and for a general audience; instead, use stop responding or a contextually relevant term in user documentation.
In general, avoid using directional language such as left, right, up, down in instructions to locate 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 or other content. Directional language proves to be difficult for accessibilityAccessibilityAccessibility (commonly shortened to a11y) refers to the design of products, devices, services, or environments for people with disabilities. The concept of accessible design ensures both “direct access” (i.e. unassisted) and “indirect access” meaning compatibility with a person’s assistive technology (for example, computer screen readers). (https://en.wikipedia.org/wiki/Accessibility) or for localization. People with cognitive impairments, as well as people using assistive technologies such as screen-reading software and might have difficulty interpreting directional language. If a particular UI element or other content is difficult to convey, include a screenshot or illustration.
Whenever possible, use a more specific term, such as document, zip file, or CSSCSSCSS is an acronym for cascading style sheets. This is what controls the design or look and feel of a site. file.
OK to use in developer documentation and for a technical audience. Avoid using in user documentation and for a general audience. Don’t use flush, flush to, flush left, or flush right to describe text alignment. Instead, use even, left-aligned, or right-aligned, as appropriate.
In general, emphasize on the task to be accomplished, rather than how the user should interact with the UI element. In developer content, folders are usually referred to as directories.
Not all folders contain files or other folders. Describe the nature or appearance of the folder if necessary.
In procedures and instructions, use bold formatting for the folder name if you’re instructing the user to interact with the folder.
Use following as an adjective to introduce a table, list, or other content. If following is the last word before what it introduces, follow it with a colon.
Examples
Tip:Recommended: The following table shows the 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.APIAPIAn API or Application Programming Interface is a software intermediary that allows programs to interact with each other and share data in limited, clearly defined ways. reference:
Don’t use to describe any geographic locations. Instead, use the names of the respective countries or regions, or use phrases such as countries other than the US and US only.
OK to use in developer documentation and for a technical audience. Avoid using in user documentation and for a general audience; instead, use interface, program, app, or a contextually relevant and accurate term.
