El área de aprendizaje de MDN es nuestro hogar para artículos que presentan conceptos web a nuevos desarrolladores. Debido a que su contenido está dirigido principalmente a principiantes, es un gran lugar para compartir sus conocimientos y ayudar a los recién llegados a conocer la Web. Es importante asegurarse de que los nuevos desarrolladores puedan seguir este contenido, por lo que le prestamos especial atención.

Este artículo explica cómo escribir páginas para el Área de aprendizaje.

Como escribir un articulo en el Área de Aprendizaje

Para comenzar a aportar su conocimiento, simplemente haga clic en el botón verde grande, luego siga los cinco pasos a continuación. Si está buscando ideas, eche un vistazo a nuestro equipo de Trello Board.

Este artículo podría no terminar exactamente en el lugar correcto, pero al menos está en MDN. Si necesita hablar con alguien para que lo trasladen al lugar correcto, por favor  Contacte con nosotros.

Paso 1: escribe en dos líneas

La primera oración de tu artículo debe resumir qué tema vas a cubrir, y la segunda debe ir en algunos detalles más de los elementos que pondrías en el artículo. Por ejemplo:

Mientras HTML los archivos contienen contenido estructurado, CSS,otra tecnología web hace que el contenido se vea como usted quiere. En este artículo vamos a cubrir cómo funciona esta tecnología y cómo escribir su propio ejemplo básico.

Observe cómo el ejemplo explica brevemente que CSS es una tecnología web central que se usa para diseñar páginas. Eso es suficiente para que el lector tenga una idea bastante buena de lo que cubre el artículo.

Debido a que los artículos del Área de aprendizaje se dirigen principalmente a los principiantes, cada artículo debe cubrir un tema directo para no abrumar al lector con demasiada información nueva. Si no puede resumir el artículo en una oración, ¡podría estar intentando hacer demasiado en un artículo!

Paso 2: Agregar una caja superior

Luego, agregue un cuadro superior para ayudar a los lectores a orientarse en cuanto a dónde se encuentran en el proceso de aprendizaje. Aquí hay un ejemplo de un cuadro superior de"Entendiendo las URLs y su estructura". Puedes usar este artículo como modelo cuando escribas tu propio artículo.

Requisitos previos: Primero necesitas saber  como funciona Internet, que es un servidor web, y los conceptos detras de los enláces de la web.
Objetivo: Aprenderá qué es una URL y cómo funciona en la Web.

Puedes usar este artículo como modelo cuando escribas tu propio artículo.

Requisitos previos
¿Qué debe saber ya el lector para seguir el artículo? Cuando sea posible, haga de cada requisito previo un enlace a otro artículo del Área de aprendizaje que cubra el concepto (a menos que sea un artículo realmente básico que no requiere conocimiento previo)
Objetivos
Esta sección explica brevemente lo que el lector aprenderá a lo largo del artículo. Esto es un poco diferente al de una sola línea; (el one-liner resume el tema del artículo), mientras que la sección de objetivos establece específicamente lo que el lector puede esperar lograr en el transcurso del artículo.

Nota: Para crear esta tabla, puede copiar y pegar la tabla de ejemplo anterior o usar la herramienta de editor de tabla de MDN. Si elige usar la herramienta de tabla, necesita agregar específicamente la learn-box class CSS además de la predeterminada standard-table class.Para hacer esto, cuando cree o edite las propiedades de la tabla, vaya al panel "Avanzado" y configure el campo Stylesheet Classes "standard-table learn-box".

Paso 3: Escribe una descripción completa

A continuación, escriba una descripción más larga que ofrezca una descripción más completa del artículo, destacando los conceptos más importantes. ¡No olvide explicar por qué el lector debe tomarse el tiempo para aprender este tema y leer su artículo!

Paso 4: Cavar más profundo

Cuando haya terminado con todo eso, finalmente puede sumergirse profundamente en el tema. Puede estructurar esta parte de su artículo como desee (aunque no dude en consultar nuestra guía de estilo). ¡Esta es tu oportunidad para brillar! Entra en detalles explicando el tema sobre el que estás escribiendo. Proporcione enlaces a la documentación de referencia completa, explique cómo funciona la tecnología en detalle, brinde detalles de sintaxis y uso, etc. ¡Tu decides!

Como guía, aquí hay algunos consejos de escritura para principiantes:

  • Centrarse en un solo tema. Si sientes que necesitas cubrir otros temas, significa que te estás perdiendo un artículo de requisito previo o debes dividir tu artículo en más de uno.
  • Usa un inglés simple. Evite los términos técnicos cuando pueda, o al menos defínalos y haga un enlace a sus entradas del glosario cuando corresponda.
  • Incluye ejemplos sencillos para que los conceptos teóricos sean más fáciles de entender. Muchas personas aprenden mejor con el ejemplo. En lugar de escribir artículos académicos, queremos que los principiantes sigan el texto fácilmente.
  • Las ayudas visuales a menudo pueden hacer que las cosas sean más fáciles de digerir y transportar información adicional, así que siéntase libre de usar imágenes, diagramas, videos y tablas. Si está utilizando diagramas o cuadros que incluyen texto, le recomendamos que utilice SVG para que nuestros equipos de traducción puedan localizar el texto.

Eche un vistazo a las primeras secciones de nuestras Functions — reusable blocks of code para algunas buenas secciones descriptivas.

Paso 5: Proporcionar material de "aprendizaje activo"

Para ilustrar el artículo y ayudar al lector a comprender mejor lo que están aprendiendo, asegúrese de proporcionar ejercicios, tutoriales y tareas que cumplir. Al hacer que utilicen y experimenten de forma activa y práctica con los conceptos que explica su artículo, puede ayudar a "bloquear" la información en sus cerebros.

Puede elegir incluir los ejemplos directamente en la página como muestras en vivo, o vincularlos si realmente no funcionan como una muestra en vivo. Si está interesado en ayudar a crear estos valiosos materiales, lea el artículo Cree un ejercicio interactivo para ayudar a aprender la Web.

Si no puede proporcionar enlaces a materiales de aprendizaje activos existentes (no sabe de ninguno o no tiene tiempo para crearlos), debe agregar la etiqueta  al artículo. De esa manera, otros colaboradores pueden encontrar artículos que necesitan materiales de aprendizaje activo y quizás ayudarlo a encontrarlos.

Eche un vistazo a Aprendizaje activo: seleccione diferentes elementos para un ejercicio de aprendizaje interactivo en vivo, o Aprendizaje activo juegue con posibilidades para un estilo diferente de ejercicio que les exija descargar una plantilla localmente y modificarla siguiendo los pasos proporcionados.

Paso 6: Obtenga el artículo revisado y póngalo en el menú de navegación del Área de aprendizaje

Después de que hayas escrito tu artículo, avísanos para que podamos echarle un vistazo, hacer una revisión y sugerir mejoras. Una vez más, consulte nuestra sección Contáctenos para conocer las mejores maneras de comunicarse.

En el menú de navegación principal del Área de aprendizaje. Este menú es generado por la macro Barra de aprendizaje , que necesita privilegios especiales para editar, así como una vez más, hable con uno de nuestro equipo sobre cómo agregarlo.

Al menos debe agregarlo a su página; Esto se hace agregando la llamada a la macro {{LearnSidebar}} en un párrafo en la parte superior de su página.

Artículos sugeridos

¿Así es que quieres contribuir?

El equipo del Área de Aprendizaje Mantiene ONU Tablero de Trello las ideas Con de Artículos para Escribir. ¡Siéntete libre de elegir uno y ponte a trabajar!

Etiquetas y colaboradores del documento

Etiquetas: 
Colaboradores en esta página: BubuAnabelas, SphinxKnight, FranciscoImanolSuarez
Última actualización por: BubuAnabelas,