Welcome to the official home of the WordPress Documentation Team.
This team is responsible for coordinating all documentation initiatives around WordPress, including the handbooks and other general wordsmithing across the WordPress project.
Want to get involved?
Start here to find out more about what we do and how to contribute:
Documentation Issue Tracker on GitHub: Submit any Documentation Team-related issues 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.
Note:Highlight: Use cross-references to guide readers to related information.
Cross-references guide the reader to information related to the content. For additional information about internal and external references, see Link text and Capitalization in titles and headings.
If the link text doesn’t clearly specify as to why you’re referring the reader to related information, then provide explanatory information. Make the explanation specific, but don’t repeat the information text.
Examples
Warning:Not recommended: For more information, see WP-CLI Commands.
Tip:Recommended: For more information about all the available commands, see WP-CLI Commands.
If the link downloads a file, explicitly mention it, and the type of file being downloaded.
Don’t include multiple links to the same document or article within a page. However, you can add a secondary link, if you’re linking to a particular section of the document or if the page you’re linking from is long. It is also acceptable to use a secondary link if there are multiple entry points to the document you’re linking from.
In generated reference documents, while linking from one reference topic to another, use the standard linking syntax rather than hard-coding links within the reference, so that the links will change appropriately when the reference docs change.
While writing descriptions for what the cross-references link to, use about instead of on.
Examples
Warning:Not recommended: For more information on procedural steps that provide instructions to achieve a particular task, see Procedures and instructions.
Tip:Recommended: For more information about procedural steps that provide instructions to achieve a particular task, see Procedures and instructions.
When you’re linking to another page on the same server, use root-relative URLs starting with /, even if you’re linking to a page in the same directory as the page you’re linking from.
When you’re linking to pages on a different domain or server, use absolute URLs. Start the URL with https if the server you’re linking to supports HTTPS. If the server doesn’t support HTTPS, start the URL with http.
Don’t force links to open in a new tab or window. Let the reader decide how to open links. If the link needs to open in a new tab or window, notify the reader that the link will open in a new tab or window. Example
Use an external link icon to indicate that the link goes to a different domain or server. Examples of internal links are, a link from make.wordpress.org to developer.wordpress.org or a link from wordpress.org/news to the make.wordpress.org/docs subdomain. A link from developer.wordpress.org to github.com/WordPress is an example of an external link. Example
