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.
Do not use quotation marks for emphasis. Phrases in quotation marks may be interpreted by readers as irony or sarcasm.
Similarly, do not use quotation marks to indicate a command or something the user needs to type. The user may mistakenly assume the quotation marks are part of the command. Instead, use backticks (`) to create an inline code block: npm install react.
Quotation marks should be used only for direct quotes and the titles of documents.
Use the Oxford comma, which means including the final comma before and or or in a list: apples, oranges, and bananas.
Rearrange ambiguous sentences, such as My brother, the teacher, and Mr. Green came to dinner. If the brother is also the teacher, this would be better as Mr Green and my brother, the teacher, came to dinner.
Above all, be consistent. In addition to applying the above grammar rules consistently, it’s important to use terms and vocabulary consistently so as not to confuse the reader. This also makes it much easier for the localization team to translate the document.
In the following example, we use the terms data, ID, iteration, and query consistently.
To retrieve the data for all of the posts, don’t iterate through the array of IDs. This would result in a separate query being made for each ID on each iteration. It is much more efficient to make a single query that fetches all the data at once.
To retrieve the data for all of the posts, don’t iterate through the array of IDs. This would result in a separate SQL query being made for each post on each loop. It is much more efficient to make one request to the database that fetches all the results at once.