Lo que escribimos
MDN Web Docs contiene documentación neutral al navegador que permite a los desarrolladores web escribir código agnostico al navegador. En este artículo, encontrarás información sobre si un tema o tipo de contenido determinado debe incluirse en MDN Web Docs.
Políticas editoriales
Esta sección describe las políticas establecidas por el personal de Mozilla MDN para controlar el contenido de MDN Web Docs. Se espera que todos los colaboradores de MDN Web Docs cumplan con estas políticas.
Relevancia
Todo el contenido de MDN Web Docs debe ser relevante para la sección de tecnología en la que aparece. El spam (publicidad comercial) y otros contenidos irrelevantes nunca serán aceptados en el sitio. Los colaboradores que sigan intentando enviar spam pueden ser expulsados de MDN a discreción del personal de Mozilla MDN.
Los enlaces salientes a sitios comerciales que sean relevantes para el tema desde el que se enlazan se evaluarán caso por caso. Su valor para ayudar a los desarrolladores web debe superar el beneficio comercial del sitio vinculado.
Neutralidad
Los artículos en MDN Web Docs deben mantener un punto de vista neutral, informando sobre las variaciones del navegador sin sesgo editorial. No se aceptan comentarios despectivos sobre ningún navegador o agente de usuario.
Estandarización
Las tecnologías web que se documentarán en MDN Web Docs deben estar en una pista estándar y deben ser implementadas por al menos un motor de renderizado. Las variaciones en el soporte del navegador se documentan en la sección Compatibilidad con los navegadores de un artículo.
Sugerir contenido
Si desea sugerir contenido para MDN Web Docs, asegúrese de leer esta página antes de enviarlo para asegurarse de que lo que está sugiriendo sea apropiado.
Para nuevas páginas o guías de referencia, abre un nuevo issue que describa qué contenido sugieres y por qué (sé lo más explícito posible).
Para sugerir proyectos más grandes que involucren nuevas secciones de contenido, consulte la página Criterios de inclusión, que también describe el proceso de solicitud.
Temas que pertenecen a MDN Web Docs
En general, si se trata de una tecnología web abierta, la documentamos en MDN Web Docs. Esto incluye cualquier característica que pueda ser utilizada por los desarrolladores web para crear sitios web y aplicaciones, ahora y en un futuro próximo.
Si una función es implementada por varios navegadores y aceptada como estándar o está avanzando hacia la estandarización, entonces sí, definitivamente la documentamos aquí. Si una función sigue siendo muy experimental y no se implementa en varios navegadores y/o puede cambiar, entonces sigue siendo adecuada para su inclusión, pero es posible que no se considere una prioridad para que el equipo de redacción trabaje en ella.
En otras palabras, las tecnologías web que se documentarán en MDN Web Docs deben cumplir los siguientes criterios:
- Estar en una pista estándar.
- Estar especificado en una especificación publicada por un organismo de normalización fiable.
- Ser implementado por al menos un motor de renderizado.
- Se lanzará en una versión de navegador estable.
Nuestro objetivo principal es escribir sobre las siguientes tecnologías web front-end:
También documentamos algunos temas más amplios, como SVG, XML, WebAssembly y Accesibilidad. Además, proporcionamos extensas guías de aprendizaje para estas tecnologías y también un glosario.
Nota: Las tecnologías de backend generalmente tienen su propia documentación en otro lugar que MDN Web Docs no intenta reemplazar, aunque tenemos algunas excepciones.
Todo el contenido de MDN Web Docs debe ser relevante para la sección de tecnología en la que aparece. Se espera que los colaboradores sigan estas pautas de escritura de MDN para el estilo de escritura, las muestras de código y otros temas.
Para obtener más detalles sobre los criterios para documentar o no una tecnología en MDN Web Docs, consulte la página Criterios de inclusión.
Cuando documentamos una nueva tecnología
En MDN Web Docs, buscamos constantemente documentar las nuevas tecnologías de estándares web según corresponda. Tratamos de encontrar un equilibrio entre publicar la documentación lo suficientemente pronto para que los desarrolladores puedan conocer las nuevas funciones tan pronto como lo necesiten y publicarla lo suficientemente tarde para que la tecnología esté madura y estable para que la documentación no necesite actualizaciones constantes o eliminación rápida.
En general, nuestra definición de lo más pronto que consideraremos documentar una nueva tecnología es: Cuando la función está en una pista de estándares y se implementa en algún lugar.
Consideramos documentar una nueva tecnología si:
- Está especificada en un documento de especificación publicado bajo una organización de estándares confiable (como W3C, WHATWG, Khronos, IETF, etc.) y ha alcanzado un nivel razonable de estabilidad (por ejemplo, un borrador de trabajo del W3C o una recomendación candidata o cuando la especificación se ve bastante estable a juzgar por el flujo de problemas presentados en su contra).
- Está implementada consistentemente en al menos un navegador, con otros desarrolladores de navegadores mostrando signos de interés (como un ticket activo o un proceso de "intención de implementar" está en efecto).
No documentamos una nueva tecnología si:
- No tiene una especificación o la especificación es una nota aproximada que parece susceptible de cambiar.
- Uno o ningún navegador lo han implementado actualmente y los navegadores no compatibles no muestran signos de interés en implementarlo. Puede medir esto preguntando a los ingenieros que trabajan en esos navegadores y mirando los rastreadores de errores del navegador y las listas de correo, etc.
- No es una tecnología expuesta en la web y/o es completamente propietaria.
- Ya está mostrando signos de ser obsoleta o reemplazada por una función similar.
Temas que no pertenecen a MDN Web Docs
En general, cualquier cosa que no sea un estándar web abierto no pertenece a MDN Web Docs. El spam (publicidad comercial) y otros contenidos irrelevantes nunca serán aceptados en el sitio. Los colaboradores que sigan intentando enviar spam pueden ser expulsados de MDN a discreción del personal de Mozilla MDN.
Algunos ejemplos de temas inapropiados para MDN Web Docs son:
- Tecnología que no está expuesta a la web y es específica de un navegador.
- Tecnología no relacionada con la web.
- Documentación para usuarios finales. Para los productos Mozilla, por ejemplo, dicha documentación pertenece al sitio de soporte de Mozilla.
- Enlaces externos de autoenlace o autopromoción. Consulta estas pautas en nuestra guía de estilo de escritura antes de añadir un enlace externo.
Cuando eliminamos documentación
Las páginas se eliminan de MDN Web Docs si ya no contienen información que es útil de alguna manera, están lo suficientemente desactualizadas o pueden ser incorrectas hasta el punto de que mantenerlas puede ser engañoso.
Los siguientes ejemplos describen situaciones en las que se pueden eliminar páginas/contenido:
- Los artículos contienen información sobre funciones que no se implementaron en todos los navegadores y que luego se retiraron (generalmente funciones experimentales, como la funcionalidad con prefijo).
- Las páginas de referencia describen características que se eliminaron de la especificación antes de implementarse en cualquier navegador.
- Los artículos cubren técnicas que luego se demostró que eran malas prácticas y fueron reemplazadas por mejores técnicas.
- Los artículos contienen información que luego fue reemplazada por otros artículos de mejor calidad.
- Los artículos contienen contenido inapropiado para MDN Web Docs.
- Las secciones de MDN Web Docs no se centran en tecnologías web abiertas y son una carga de mantenimiento.
Para obtener más información sobre cómo eliminar documentos, consulta la guía Crear, mover y eliminar páginas.
Tipos de documentos permitidos en MDN Web Docs
En general, nuestra documentación se clasifica en las siguientes categorías:
- Referencias
- Guías
- Glosarios
- Aprender/Tutoriales
En general, MDN Web Docs es para la documentation de productos, no para documentation de proyectos o procesos. Entonces, si el documento trata sobre "cómo usar una cosa" o "cómo funciona una cosa" (donde, la "cosa" está en una de las categorías de temas mencionadas anteriormente), entonces puede ir a MDN Web Docs.
Si un documento trata sobre "quién está trabajando en el desarrollo de una cosa" o "planes para desarrollar una cosa", entonces no debería ir en MDN Web Docs.
Estos son algunos ejemplos de tipos de documentos que no deberían colocarse en MDN Web Docs:
- Documentos de planificación
- Documentos de diseño
- Propuestas de proyectos
- Especificaciones o normas
- Material promocional, publicidad o información personal