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/
Join our discussions of documentation issues here on the blog and on Slack.
An ellipsis (plural: ellipses) is a set of three contiguous dots that are used to indicate omission of part of a sentence, phrase, paragraph, or content. For documentation purposes, use three periods as the dots in an ellipse, unless you use an ellipsis character. An ellipsis is also used in informal writing to connote a subsiding, hesitating, or fading expression. The word ellipsis originates from the Greek word meaning “omission”.
Use three contiguous periods in a row while writing an ellipsis. Avoid using the ellipsis character and make use of periods in general. Insert one space before and after the ellipsis unless a punctuation mark immediately follows the ellipsis; in this case, don’t insert a space after the ellipsis.
Warning:Not recommended: You need to wait for the post to save…and then publish the post.
Tip:Recommended: You need to wait for the post to save … and then publish the post.
Don’t use ellipses in your documentation. If you have to use ellipses in your documentation, rewrite your content excluding all unnecessary information while including the necessary information. Using ellipses in quoted text is acceptable, unless they appear at the beginning or the end of the text.
Warning:Not recommended: The WordPress Documentation handbook states “The Codex is a community-created repository for WordPress ….”
Warning:Not recommended: The WordPress Documentation handbook states: ” … and only a 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/ user account is required to create a page.”
Tip:Recommended: The WordPress Documentation handbook states “The Codex is a community-created repository for WordPress, … And only a 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/ user account is required to create a page.”
Only use ellipses in user interfaces if it is absolutely needed to indicate a pause in conversational UI messages. For example, the text in a UI message might read “Searching the database …“.
When UI elements have text with ellipses in them, exclude them from the documentation describing that UI element, unless it could cause confusion. For example, if the text in the user interface reads “Publish …“, document the text as “click Publish“.
If required, you can use ellipses in multiple-part callouts, such as in images, illustrations, screenshots, and graphics. Insert a space before the ellipsis at the end of a phrase that continues later; and insert an ellipsis followed by a space at the beginning of a phrase that’s continued from a previous phrase. If the callout ends with additional punctuation, such as a period or comma, insert a space between the punctuation mark and the ellipsis.
When ellipses are used to connote hesitation, a pause, or an unfinished thought, they are known as suspension points. Generally, suspension points indicate an informal, spoken language tone. Avoid using suspension points in your documentation.
Warning:Not recommended: The package installation might not run … but we’ll see.