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.
a11yAccessibilityAccessibility (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), 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)#a11y, accessibility
Abbreviation for accessibility.
It’s OK to abbreviate localization as a11y. Spell out on the first mention.
Don’t use accessible as a synonym for simple. Instead, use easy to use or intuitive.
For more information about spelling out abbreviations, see Abbreviations.
For more information about writing for a global audience, see Accessbility.
Don’t use for a range of numbers. Instead, use later.
Don’t use to refer to a position in the UI. In general, avoid using directional language in instructions to locate UI elements or other content. Directional language proves to be difficult for 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.
Use admin or administrator unless you need to specify a particular administrator such as system administrator, network administrator, or database administrator.
Don’t use. Instead, spell out as also known as, present an alternative term using parentheses or the word or, or use a contextually relevant term. You can also write out a definition.
Examples
Warning:Not recommended: Localization, aka l10n, is a process by which a product or service is translated and adapted to another language and culture along with its documentation.
Tip:Recommended: Localization, also known as l10n, is a process by which a product or service is translated and adapted to another language and culture along with its documentation.
Tip:Recommended: Localization (l10n) is a process by which a product or service is translated and adapted to another language and culture along with its documentation.
Tip:Recommended: Localization, or l10n, is a process by which a product or service is translated and adapted to another language and culture along with its documentation.
Use to refer to the alignment of text to the left or right margin. Don’t use justification. Justified text is text that is aligned on both the right and the left margins. To describe alignment on one margin only, use left-aligned or right-aligned, not left-justified or right-justified.
Avoid using. Instead, rephrase the sentence without using the term.
Don’t use allows you to. 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.
In general, don’t hyphenate words beginning with anti- such as antivirus and antialiasing, unless anti- is followed by a proper noun or it is absolutely necessary to avoid confusion.
In general, don’t hyphenate words beginning with auto- such as autosave, autoplay, and autoscale, unless auto- is followed by a proper noun or it is absolutely necessary to avoid confusion.
