Skip to content

Commit 55d21c5

Browse files
author
Gregg Juan Eduardo Palomo Herrera
authored
1 parent 9d2159c commit 55d21c5

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

Documentación.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
title: About GitHub's documentation fundamentals
3+
shortTitle: Documentation fundamentals
4+
intro: 'All content published on {% data variables.product.prodname_docs %} must meet these fundamental requirements.'
5+
versions:
6+
fpt: '*'
7+
ghec: '*'
8+
ghes: '*'
9+
---
10+
11+
## About {% data variables.product.github %}'s documentation fundamentals
12+
13+
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.
14+
15+
## Accurate
16+
17+
Documentation is correct and accurate.
18+
19+
* Ensure that the content is free from factual errors.
20+
* Ensure that the content is free from spelling and formatting errors.
21+
22+
## Accessible and inclusive
23+
24+
Documentation is up to date with the latest accessibility standards, and is written to be inclusive and translation-friendly.
25+
26+
* Ensure content adheres to the accessibility and screenshot guidelines. For more information, see [AUTOTITLE](/contributing/writing-for-github-docs/creating-screenshots).
27+
* Ensure content can be successfully translated. For more information, see [AUTOTITLE](/contributing/writing-for-github-docs/writing-content-to-be-translated).
28+
29+
## Consistent
30+
31+
Documentation maintains a consistent voice, tone, and style throughout, creating a cohesive experience for readers.
32+
33+
* 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).
34+
* Apply consistent terminology and naming conventions.
35+
* Use branding elements (for example, product and feature names, logos, color schemes) consistently in the content.

0 commit comments

Comments
 (0)