jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-22 03:16:52 -05:00
Code Issues Projects Releases Wiki Activity

Part 1 of 2: publicize docs fundamentals, simplify self-review checklist and pull request template (#52624)

Browse Source 
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:
Joe Clark
2024-11-25 10:45:50 -08:00
committed by GitHub
parent 40bbab639b
commit f07eebbdb1
9 changed files with 46 additions and 88 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
content/contributing/writing-for-github-docs/about-githubs-documentation-fundamentals.md Normal file
View File

@@ -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.