Esta traducción está incompleta. Por favor, ayuda a traducir este artículo del inglés.
The MDN glossary is the place where we define all the terminology, jargon, and abbreviations that are used in documentation and coding. Contributing to the glossary is an easy way to make the web easier for everyone to understand. Because glossary entries should be simple and straightforward, it's not necessary to have a high degree of technical skill to write it.
Como escribir una entrada
Presione el siguiente botón y siga las instrucciones:
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. De esta manera cualquiera que este leyendo el glosario debe de poder entender la definición del término inmediatamente.
Este resumen es también utilizado para crear a un “tooltip” para cualquiera de los hipervínculos hacia cualquiera de los términos del glosario; esto permite al usuario ver inmediatamente la definición del glosario. Hipervínculos al glosario son hechos usando la siguiente macro Glossary:
| Macro | Resultado |
|---|---|
| {{Glossary("Browser")}} | Browser |
| {{Glossary("Browser", "Web browser")}} | Web browser |
| {{Glossary("Browser", "Web browser", 1)}} | Web browser |
Como se puede ver, escribir un buen resumen corto y simple es muy importante.
Paso 2: Escribir una sección detallada
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.
Step 3: Open up with links
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!