Pautas de redacción

MDN Web Docs es un proyecto de código abierto. Las secciones descritas a continuación detallan nuestras pautas sobre qué documentamos y cómo lo hacemos en MDN Web Docs. Para saber cómo contribuir, consulta nuestras guías de contribución.

Qué escribimos

Esta sección cubre qué incluimos en MDN Web Docs y qué no, además de otras políticas: cuándo escribimos sobre nuevas tecnologías, el proceso para sugerir contenido y si aceptamos enlaces externos. Es un buen punto de partida si estás considerando escribir o actualizar contenido para nosotros.

Criterios de inclusión

Este artículo describe en detalle los criterios para el contenido que se incluirá en MDN Web Docs, el proceso para solicitar la inclusión de nueva documentación y las expectativas y pautas para los solicitantes.

Nuestra guía de estilo de redacción

La guía de estilo de redacción cubre el lenguaje y el estilo que usamos al redactar en MDN Web Docs. También abarca cómo formatear ejemplos de código.

Pautas de redacción para Aprende desarrollo web

La sección "Aprende desarrollo web" de MDN está dirigida específicamente a personas que están aprendiendo los fundamentos básicos del desarrollo web y, como tal, requiere un enfoque diferente al del resto del contenido de MDN. Este artículo ofrece pautas para redactar contenido de aprendizaje.

Cómo escribir para MDN Web Docs

Esta sección cubre toda la información necesaria para crear y editar páginas, incluidos ciertos procesos y técnicas que seguimos. Esta sección proporciona información sobre cómo empezar, una descripción general de cómo se estructuran las páginas y dónde encontrar tutoriales sobre tareas específicas. Esta sección incluye temas como:

Cómo investigar una tecnología

Esta sección ofrece algunos consejos útiles para investigar una tecnología que estás documentando.

Cómo crear, mover y eliminar páginas

Esta sección explica cómo creamos, movemos o eliminamos una página en MDN Web Docs. También explica cómo redirigimos una página cuando la movemos o eliminamos.

Cómo retirar una sección de contenido

Esta sección explica el proceso para retirar secciones completas del contenido de MDN Web Docs de manera planificada y transparente, incluyendo la toma de decisiones, los períodos de aviso, el archivado y la eliminación.

Cómo usar markdown

El formato markdown que usamos deriva de GitHub Flavored Markdown (GFM). Esta sección es una guía del markdown que usamos en MDN Web Docs, con los formatos para componentes específicos de la página, como notas y listas de definición.

Añadir imágenes y medios

Esta sección describe los requisitos para incluir contenido multimedia en las páginas, como imágenes.

Cómo documentar una propiedad CSS

Este artículo explica cómo escribir una página de propiedad CSS, incluyendo el diseño y el contenido.

Cómo documentar una referencia de API

Esta sección explica cómo abordar la documentación de una API web.

Cómo documentar una cabecera HTTP

Este artículo explica cómo crear una nueva página de referencia para una cabecera HTTP.

Cómo añadir una entrada al glosario

Este artículo explica cómo añadir y vincular entradas en el glosario de MDN Web Docs. También ofrece pautas sobre el diseño y el contenido de las entradas del glosario.

Tipos de página en MDN Web Docs

Cada página de MDN Web Docs tiene un tipo de página específico, ya sea una página de referencia de CSS o una guía de JavaScript. Esta sección enumera los distintos tipos de página y ofrece plantillas para cada uno. Es una buena idea revisarlos para entender qué tipo de página estás redactando.

Estructuras de página en MDN Web Docs

Esta sección cubre las distintas estructuras de página que usamos para presentar la información de manera coherente en MDN Web Docs. Incluye:

Secciones de sintaxis

La sección de sintaxis de una página de referencia en MDN Web Docs contiene un bloque específico que define la sintaxis exacta de una característica. Este artículo explica cómo redactar estos bloques de sintaxis para los artículos de referencia.

Ejemplos de código

Hay muchas formas distintas de incluir ejemplos de código en las páginas. Esta sección las describe y ofrece pautas de sintaxis para los diferentes lenguajes.

Banners y avisos

A veces, un artículo necesita que se le añada un aviso especial. Esto puede ocurrir si la página trata sobre tecnología obsoleta u otro material que no debería usarse en código de producción. Este artículo cubre los casos más comunes y cómo gestionarlos.

Tablas de especificaciones

Cada página de referencia en MDN Web Docs debe proporcionar información sobre la especificación o especificaciones en las que se definió esa API o tecnología. Este artículo muestra el aspecto de estas tablas y explica cómo añadirlas.

Tablas de compatibilidad

MDN Web Docs tiene un formato estándar para las tablas de compatibilidad de nuestra documentación web abierta. Este artículo explica cómo añadir entradas a la base de datos que genera dichas tablas, cómo mantenerla y cómo integrar las tablas en los artículos.

Macros

Las macros son atajos que se utilizan en las páginas para generar contenido, como barras laterales. Esta sección enumera las macros que usamos y lo que hacen.

Atribución y licencia de derechos de autor

Describe nuestra política sobre el uso de contenido de MDN Web Docs en otros lugares de la web, cómo obtener permiso para volver a publicar contenido en MDN y sugerencias para enlazar contenido de MDN.

Cómo etiquetar una tecnología

Esta sección cubre nuestras definiciones de los términos "en desuso", "obsoleto" y "experimental", y ofrece pautas sobre cómo etiquetar una tecnología con ellos y cuándo eliminamos contenido de MDN Web Docs.