About GitHub's documentation fundamentals
These fundamentals are required for GitHub documentation. Use the lists below to help ensure your contributions are accurate, accessible and inclusive, and consistent.
Accurate
Documentation is correct and accurate.
- Ensure that the content is free from factual errors.
- Ensure that the content is free from spelling and formatting errors.
Accessible and inclusive
Documentation is up to date with the latest accessibility standards, and is written to be inclusive and translation-friendly.
- Ensure content adheres to the accessibility and screenshot guidelines. For more information, see "创建屏幕截图."
- Ensure content can be successfully translated. For more information, see "编写要翻译的内容."
Consistent
Documentation maintains a consistent voice, tone, and style throughout, creating a cohesive experience for readers.
- Ensure content adheres to the GitHub Docs style guide. For more information, see "风格指南."
- Apply consistent terminology and naming conventions.
- Use branding elements (for example, product and feature names, logos, color schemes) consistently in the content.