36 lines
1.7 KiB
Markdown
36 lines
1.7 KiB
Markdown
---
|
|
title: About GitHub's documentation fundamentals
|
|
shortTitle: Documentation fundamentals
|
|
intro: 'All content published on {% data variables.product.prodname_docs %} must meet these fundamental requirements.'
|
|
versions:
|
|
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](/contributing/writing-for-github-docs/creating-screenshots).
|
|
* Ensure content can be successfully translated. For more information, see [AUTOTITLE](/contributing/writing-for-github-docs/writing-content-to-be-translated).
|
|
|
|
## 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](/contributing/style-guide-and-content-model/style-guide).
|
|
* Apply consistent terminology and naming conventions.
|
|
* Use branding elements (for example, product and feature names, logos, color schemes) consistently in the content.
|