about-githubs-documentation-fundamentals.md

title	shortTitle	intro	versions
About GitHub's documentation fundamentals	Documentation fundamentals	All content published on {% data variables.product.prodname_docs %} must meet these fundamental requirements.	fpt ghec ghes * * *

About {% data variables.product.github %}'s documentation fundamentals

These fundamentals are required for {% data variables.product.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 AUTOTITLE.
• Ensure content can be successfully translated. For more information, see AUTOTITLE.

Consistent

Documentation maintains a consistent voice, tone, and style throughout, creating a cohesive experience for readers.

• Ensure content adheres to the {% data variables.product.prodname_docs %} style guide. For more information, see AUTOTITLE.
• Apply consistent terminology and naming conventions.
• Use branding elements (for example, product and feature names, logos, color schemes) consistently in the content.