Part 1 of 2: publicize docs fundamentals, simplify self-review checklist and pull request template (#52624)
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Co-authored-by: Hector Alfaro <hectorsector@github.com> Co-authored-by: Ben Ahmady <32935794+subatoi@users.noreply.github.com> Co-authored-by: Kevin Heis <heiskr@users.noreply.github.com>
This commit is contained in:
@@ -0,0 +1,33 @@
|
||||
---
|
||||
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:
|
||||
feature: 'contributing'
|
||||
---
|
||||
|
||||
## 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.
|
||||
@@ -10,9 +10,10 @@ versions:
|
||||
|
||||
At {% data variables.product.prodname_dotcom %}, we strive to create documentation that is accurate, valuable, inclusive, accessible, and easy to use.
|
||||
|
||||
Before contributing to {% data variables.product.prodname_docs %}, please take a moment to familiarize yourself with {% data variables.product.prodname_dotcom %}'s documentation philosophy and content design principles:
|
||||
Before contributing to {% data variables.product.prodname_docs %}, please take a moment to familiarize yourself with {% data variables.product.prodname_dotcom %}'s documentation philosophy, fundamentals, and content design principles:
|
||||
|
||||
* [AUTOTITLE](/contributing/writing-for-github-docs/about-githubs-documentation-philosophy)
|
||||
* [AUTOTITLE](/contributing/writing-for-github-docs/about-githubs-documentation-fundamentals)
|
||||
* [AUTOTITLE](/contributing/writing-for-github-docs/content-design-principles)
|
||||
|
||||
## Best practices for writing {% data variables.product.prodname_dotcom %} documentation
|
||||
|
||||
@@ -7,6 +7,7 @@ versions:
|
||||
children:
|
||||
- /best-practices-for-github-docs
|
||||
- /about-githubs-documentation-philosophy
|
||||
- /about-githubs-documentation-fundamentals
|
||||
- /content-design-principles
|
||||
- /writing-content-to-be-translated
|
||||
- /making-content-findable-in-search
|
||||
|
||||
Reference in New Issue
Block a user