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.
Note:Highlight: Write unbiased examples without revealing personally identifiable information.
Providing examples in documentation helps the reader visualize concepts. Be thoughtful while writing and coming up with fictitious examples and scenarios; sometimes they may be unintentionally biased. As well as writing diverse and inclusive documentation, don’t reveal personally identifiable information such as real names, addresses, phone numbers, email addresses, or financial information. In addition to fictitious examples and scenarios, you can also use placeholder variables such as EMAIL_ADDRESS or PHONE_NUMBER.
In general, write examples and scenarios with a global perspective. Some scenarios may be improbable in some regions, and some may be different altogether. Social customs, politics, events, holidays, sports, traditions, religion, and legal and business practices vary worldwide. Avoid discussing technologies and standards that aren’t adopted worldwide; don’t assume US standards are familiar to everyone. Be thoughtful on how these fictional scenarios would be perceived by a global audience.
When you need people’s names and their activities in an example, use fictional character names from non-copyrighted material. Don’t use character names from copyrighted content such as movies, television shows, or books. Also, don’t use real people’s names.
If you can’t think of a fictional character name that is not copyrighted, you can invent new names; although be thoughtful while thinking of new names. Ensure a diverse, inclusive, and global demographic while writing examples with people’s names.
If another guideline specifically defines fictional person names, use those names in your examples.
When you need an organization name in an example, use Example Organization. If you need multiple organization names or need to differentiate between two fictional companies, add a description to the organization names. For example, you can use Example Tech Organization and Example Education Organization.