Esta traducción está incompleta. Por favor, ayuda a traducir este artículo del inglés.

El glosario MDN es el sitio donde definimos toda la terminología, jerga, y abreviaciones usadas en la documentación y en la codificación. Contribuir al glosario es una manera simple de hacer la Web más fácil para que todo el mundo la entienda. No necesitas un nivel alto de conocimientos técnicos para escribir entradas en el glosario, porque éstas deberían ser simples y sencillas.

Este artículo describe como escribir una buena entrada al glosario acerca de un tema para el sitio web de MDN docs.

Como escribir una entrada

Si estás buscando temas que necesitan una entrada al glosario, revisa la lista de temas indocumentados en el final de la página principal del Glosario; sigue cualquiera de esos enlaces para empezar una nueva página al Glosario para el item que has seguido;después digue los pasos más abajo.

Si tienes una idea para una nueva entrada al glosario, simplemente abre el siguiente botón en una nueva pestaña y sigue las instrucciones siguientes al botón:

Paso 1: Escribir un resumen

El primer párrafo de cualquiera de las páginas del glosario es una descripción simple y corta del término, preferentemente de no más de una o dos oraciones. Asegúrate de que cualquiera que esté leyendo el glosario debe de poder entender la definición del término inmediatamente.

Nota: Por favor no copies y pegues definiciones de cualquier otro sitio (especialmente no de la Wikipedia, ya que su rango de licencias es más pequeño, y lo hace incompatible con MDN). Es realmente importante que el contenido sea simple y fácil de entender. Merece la pena dedicarle algo de tiempo en lugar de robar contenido a ciegas. Este glosario debería ser contenido nuevo útil, no cosas repetidas de cualquier otro sitio.

Los enlaces a la entrada del glosario usarán esos resúmenes en sus tooltips, de tal forma que los lectores puedan ver las definiciones sin navegar fuera de la página donde se encuentran. (Ver más abajo como insertar enlaces a entradas del glosario con la macro {{Glossary}} .)

Si debes, tu puedes añadir algún párrafo extra, pero es muy fácil verte escribiendo un artículo entero. Escribir un artículo completo está bien, pero por favor no lo pongas en el glosario. Si no estás seguro de dónde poner tu artículo, sienteté libre de discutirlo.

Paso 2: Extenderse con los enlaces

Finalmente, una entrada al glosario debería terminar siempre con una sección "Aprender más" . Esta sección debería contener enlaces para ayudar al lector a prograsar: descubrir nuevos detalles, aprender a usar la tecnología relevante, etc.

Recomendamos que ordenes los enlaces al menos en estos tres grupos:

 

Esta sección es donde se puede escribir una descripción más detallada. En esta sección no hay que dudar en explicar todos los detalles necesarios, proveer algún contexto o detalles históricos interesantes, etc. Depende de usted. Lo que hay que recordar es que debe de enfocarse en conocimiento general en lugar de en detalles técnicos. Si desea escribir en detalles técnicos, es mejor escribir un artículo regular en MDN. La intención del glosario es proveer información a la audiencia general, así que un principiante debe de poder comprender esta sección.

As an example, take a look at the "JavaScript" term definition.

Finally, a glossary entry should always end with a "Know more" section. This section should contain links to help the reader move forward: discovering more details, learning to use the relevant technology, and so on.

We recommend that you categorize the links in at least these three categories:

General knowledge
Links that provide more general information; for example, a link to Wikipedia is a good starting point.
Technical reference
Links to more in-depth technical information. These links can be to pages on MDN or elsewhere on the Internet.
Learn about it
Links to tutorials, exercises, or any other teaching materials that can directly help the reader learn to use the technology behind the term being defined.

Suggested terms

Do you want to contribute but you don't know which terms need to be defined? Here's a list of suggestions. Click one and get started!

 

 

Etiquetas y colaboradores del documento

Etiquetas: 
 Colaboradores en esta página: astrapotro, teoli, L_e_o
 Última actualización por: astrapotro,