Estructura de un artículo de la Base de Conocimientos

Información de la revisión
  • Identificador de la revisión: 305061
  • Creada:
  • Creador/a: SuMo Bot
  • Comentario: Automatically approved because it was not reviewed within 72 hour(s).
  • Revisado:
  • Revisado:
  • Revisado por: SumoBot
  • ¿Está aprobado?
  • ¿Es la versión actual?
  • Listo para localización: No
Origen de la revisión
Contenido de la revisión

Esta introducción en vídeo te da algo de contexto para el siguiente artículo y un breve resumen de su contenido. Al ver el vídeo, puedes determinar rápidamente si este es el artículo adecuado para ti.

¿Quieres aprender a escribir artículos de ayuda para la Ayuda de Mozilla? Este artículo te muestra ejemplos de nuestras técnicas de redacción más comunes y del marcado wiki importante. Puedes utilizar tanto el artículo como su fuente del marcado como guía cuando escribas un artículo.

En general, tenemos dos tipos básicos de artículos con dos tipos de introducciones:

  • Tutoriales o artículos de "cómo hacer": Un breve resumen de la función o tarea y lo que se puede aprender (ejemplo).
  • Artículos de resolución de problemas: Un breve resumen de los síntomas y las posibles soluciones (ejemplo).

Cómo estructurar un artículo

La idea general aquí es intentar desarrollar las habilidades de lo simple a lo complejo, mientras se intenta mantener la información que necesita la mayoría de la gente cerca de la parte superior. Así, una solución simple y común normalmente iría antes que una solución compleja o para un caso particular.

Escribe encabezados de sección descriptivos para que los lectores puedan escanear rápidamente

Nombrar el encabezado de la sección según la tarea o la solución permite al lector navegar rápidamente por el artículo o escanear la tabla de contenidos para ver el alcance del artículo. En algunos casos, esto ya puede proporcionar suficiente información para algunos usuarios y ni siquiera necesitarían leer el resto del artículo.

Crear instrucciones paso a paso

No hay nada más frustrante que encontrar por fin las instrucciones que necesitas y quedarte atascado al intentar seguirlas porque quien las escribió asumió que sabías algo que no sabías. Por eso, desglosamos nuestras instrucciones en pasos completos y numerados. Si tienes que hacer clic en "OK" en algún momento, incluso lo definimos como un paso.

Aquí tienes un ejemplo del artículo Cómo configurar la página de inicio:

  1. Abre la página web que quieres usar como tu página de inicio.
  2. Arrastra y suelta esa pestaña sobre el botón de Inicio Fx89HomeButton en tu barra de herramientas.
    Fx89 Set homepage drag-and-drop
  3. Haz clic en Yes en el aviso para establecer esta página como tu página de inicio.

Consejo: Echa un vistazo a la fuente del wiki para ver cómo se hace.

Crear instrucciones para diferentes sistemas operativos o versiones de Firefox

A menudo, las instrucciones de Firefox son diferentes para los distintos sistemas operativos. Tenemos un marcado wiki especial que muestra las instrucciones de Windows a los usuarios de Windows, las de Linux a los usuarios de Linux y las de Mac a los usuarios de Mac. Si cambias el sistema operativo en el cuadro "Personalizar este artículo" de la derecha, las instrucciones que aparecen a continuación cambiarán según el sistema operativo seleccionado. Este ejemplo es del artículo Averigua qué versión de Firefox estás usando.

Haz clic en el botón de menú Fx89menuButton, haz clic en Help y selecciona About Firefox.En la barra de menús, haz clic en el menú Firefox y selecciona About Firefox. Aparecerá la ventana "Acerca de Firefox". El número de versión aparece debajo del nombre de Firefox.

Consejo: Echa un vistazo a la fuente del wiki para ver cómo se hace. Puedes aprender más sobre el uso del marcado {for} en este artículo.

Usar plantillas en tus instrucciones

Hay muchos pasos comunes en los artículos de Firefox. Para estos, creamos "plantillas" para no tener que escribirlos (y traducirlos) una y otra vez. Normalmente, las plantillas incluyen instrucciones para todos los sistemas operativos, lo que simplifica y acelera mucho la redacción de los pasos.

Este ejemplo del artículo Cómo configurar la página de inicio incluye una plantilla que da instrucciones para abrir el panel de Ajustes de Firefox.

  1. En la barra de menu, haz click en Firefox y selecciona Settings (selecciona Preferences en versiones antiguas de macOS).Haz click en el botón de menu Fx89menuButton y selecciona Ajustes o Preferencias.
  2. Haz clic en el panel Home.
    Fx91HomePanel
  3. Haz clic en el menú junto a Página de inicio y ventanas nuevas y elige mostrar la página de inicio predeterminada de Firefox, URLs personalizadas o una página en blanco.

Consejo: Echa un vistazo a la fuente del wiki para ver cómo se hace. Consulta Cómo usar las plantillas para saber más sobre las plantillas.

Directrices de la Base de Conocimiento

Para más directrices sobre la contribución a la Base de Conocimiento, consulta esta página.