Cómo agregar una entrada al glosario
Este artículo explica cómo agregar y vincular entradas en el glosario de MDN Web Docs. También proporciona pautas sobre el diseño y el contenido de las entradas del glosario. El glosario ofrece definiciones para todos los términos, jerga, abreviaturas y acrónimos que encontrarás al leer contenido de MDN sobre la web y el desarrollo web.
Es posible que el glosario nunca esté completo, porque la web siempre está cambiando. Al contribuir con nuevas entradas o corregir problemas, puedes ayudarnos a mantener el glosario actualizado y llenar sus vacíos.
Contribuir al glosario es una manera fácil de ayudar a que la web sea más comprensible para todos. No necesitas habilidades técnicas avanzadas. Las entradas del glosario están pensadas para ser sencillas y breves.
Cómo escribir una entrada
Primero, elige el término para el que quieres crear una entrada en el glosario. Si buscas términos sin entrada, consulta la lista en la barra lateral de la página de inicio del glosario.
Si tienes una idea para una nueva entrada del glosario, crea una nueva página dentro de la página de inicio del glosario.
Escribir un resumen
El primer párrafo de cualquier página del glosario es una descripción breve y sencilla del término. Preferiblemente, no debe tener más de dos oraciones. Asegúrate de que quien lea la descripción entienda el término de inmediato.
Nota: Por favor, no copies y pegues de otras definiciones o contenido en Internet. (Y especialmente no de Wikipedia, ya que su rango de versiones de licencia es más reducido e incompatible con MDN.) Tu entrada en el glosario debe ser contenido original.
Escribir una buena entrada de glosario
Agrega algunos párrafos adicionales si es necesario, pero es fácil acabar escribiendo un artículo completo. Escribir un artículo está bien, pero no lo crees en el glosario ni para el glosario. Si no estás seguro de dónde colocar tu artículo, no dudes en comunicarte para discutirlo.
Hay algunas pautas sencillas a considerar para escribir una mejor entrada de glosario:
- Cuando uses términos en la descripción del término del glosario o cuando uses abreviaturas, debes crear los enlaces apropiados. A menudo, esto solo implica crear enlaces a otras páginas del glosario.
- Usa términos relacionados apropiados (con enlaces) en la entrada del glosario, siempre que sea posible sin que el artículo resulte difícil de seguir. Tener una buena red de enlaces relacionados y útiles hace que una página, o conjunto de páginas, sea mucho más fácil de usar.
- Piensa en los términos de búsqueda que usarías si quisieras encontrar esta página. Trata de usar todas las palabras que usarías para buscar el término, pero sin que la entrada pierda sentido, sea demasiado larga o difícil de leer.
Ampliar con enlaces
Una entrada del glosario siempre debe terminar con una sección Véase también. Esta sección debe contener enlaces que ayuden al lector a avanzar: descubrir más detalles y aprender a utilizar la tecnología pertinente.
Es buena práctica organizar los enlaces en tres grupos:
- Conocimiento general
-
Estos enlaces proporcionan información de alto nivel sobre el término o tema. Por ejemplo: un enlace a una página relevante de Wikipedia.
- Referencia técnica
-
Estos enlaces ofrecen información técnica detallada, ya sea en MDN Web Docs u otros sitios.
- Aprende al respecto
-
Estos son enlaces a tutoriales, ejercicios, ejemplos u otro contenido didáctico que ayude al lector a aprender.
Manejar la desambiguación
Algunos términos pueden tener múltiples significados según el contexto. Para resolver la ambigüedad, sigue estas pautas:
- La página principal del término debe ser una página de desambiguación que contenga la macro
GlossaryDisambiguation. - El término tiene subpáginas que lo definen para diferentes contextos.
Ilustremos esto con un ejemplo. El término signature puede tener diferentes significados en al menos dos contextos distintos: seguridad y función.
- La página Glossary/Signature es la página de desambiguación con la macro
GlossaryDisambiguation. - La página Glossary/Signature/Security define una firma en un contexto de seguridad.
- La página Glossary/Signature/Function define una firma de función.