Estructura de un artículo de la Base de Conocimientos

Esta es una introducción donde encontrarás un poco de contexto para este artículo y una breve descripción de lo que te vas a encontrar, lo que te ayudará a saber rápidamente si este es el artículo que estás buscando.

En este caso, quieres aprender cómo escribir artículos para la Ayuda de Mozilla. Por tanto, en este artículo te mostramos ejemplos de las técnicas de escritura más utilizadas y el wiki de códigos y estilo que utilizamos. Cuando empieces a escribir, puedes utilizar como guía tanto este artículo como la fuente del marcado.

En general, contamos con dos tipos de artículos básicos que incluyen dos tipos de instrucciones:

  • Tutoriales o artículos sobre "¿Cómo...?", que incluyen un breve resumen de características y qué cosas debemos saber. (Aquí encontrarás un ejemplo).
  • Artículos que sirven para solucionar problemas: un breve resumen de los síntomas y posibles soluciones. (Este es un ejemplo).

Cómo estructurar el artículo

La idea principal es ir de lo más sencillo a lo más complicado, intentando que lo esencial aparezca al principio del artículo. Es decir, la solución más sencilla y común aparecerá antes que la solución más compleja y difícil de ejecutar.

Por ejemplo, en este artículo, empezamos explicando por qué deberías utilizar esta característica, seguimos con las instrucciones para crear el Grupo de Pestañas y terminamos con otras funciones más complicadas como las búsquedas y organización de las pestañas.

Escribe encabezados de sección descriptivos para que los lectores puedan echar un vistazo rápido

Ponerle nombre a la sección despúes de dar la solución permite a los lectores encontrar rápidamente el artículo o echar un vistazo rápido a la tabla de contenidos para ver de qué trata. En algunos casos, el encabezado proporciona información suficiente para algunos usuarios y no tienen que seguir leyendo el resto del artículo.

Crear instrucciones paso a paso

No hay nada más frustante que encontrar las instrucciones que buscabas y darte cuenta de que no eres capaz de entenderlas porque la persona que las escribió dio por sentado que sabrías cosas que en realidad no conoces. Por eso intentamos que nuestras instrucciones vayan paso a paso y estén completas. Por ejemplo, si tienes que hacer clic en "OK", también lo incluimos.

Aquí tienes un ejemplo que hemos cogido del artículo Cómo establecer la página de inicio:

  1. Abre una pestaña con la página web que quieres que sea tu página de inicio.
  2. Arrastra la pestaña y suéltala en el botón de Inicio Home Button .
    Home Page 29 - WinXP Home Page 29 - Win8 Home Page 29 - Mac Home Page 29 - Linux
  3. Haz clic en para confirmarla como tu página de inicio.

Crea instrucciones para distintos sistemas operativos o versiones de Firefox

A veces, las instrucciones de Firefox son distintas para los diferentes sistemas operativos que existen. Contamos con un marcado wiki especial que nos indica que las instrucciones son para usuarios de Windows o para usuarios de Mac. Si cambias el sistema operativo al inicio de este artículo, todos los pasos que aparecen a continuación cambiarán.

Truco: Échale un vistazo a la funte del wiki para ver cómo se hace (por favor, no cambies el artículo).

  1. Haz clic en el botón de menú New Fx Menu y elige Opciones.
  2. Selecciona el panel General.
  3. En la sección de Inicio, haz clic en Restaurar al valor por omisión.
    HomePage-Fx34Win
  4. Haz clic en Aceptar para cerrar la ventana de Opciones.

  1. Haz clic en el botón de menú New Fx Menu y elige Preferencias....
  2. Selecciona el panel General.
  3. En la sección de Inicio, haz clic en Restaurar al valor por omisión.
    HomePage-Fx34Mac
  4. Cierra la ventana de Preferencias.

  1. Haz clic en el botón de menú New Fx Menu y elige Preferencias....
  2. Selecciona el panel General.
  3. En la sección de Inicio, haz clic en Restaurar al valor por omisión.
    HomePage-Fx34Lin
  4. Haz clic en Cerrar para cerrar la ventana de Preferencias.

Utiliza plantillas en tus instrucciones paso a paso

Hay un montón de pasos en Firefox que se repiten mucho. En estos casos, creamos "plantillas" para no tener que escribir y traducir una y otra vez lo mismo. Normalmente, las plantillas tienen instrucciones para todos los sistemas operativos, lo que facilita aún más redactar las instrucciones. A continuación vas a ver las mismas instrucciones que aparecen arriba pero utilizando las plantillas:

Truco: Échale un vistazo a la fuente del wiki para ver cómo se hace (por favor, no cambies el artículo).
  1. En la parte superior de la ventana de Firefox, haz clic en el botón Firefox y selecciona Opciones.En la parte superior de la ventana de Firefox, haz clic en el menú Herramientas y selecciona Opciones.En la barra de menús, haz clic en el menú Firefox y selecciona Preferencias….En la parte superior de la ventana de Firefox, haz clic en el menú Editar y selecciona Preferencias.

    Haz clic en el botón Menú New Fx Menu y elige OpcionesPreferencias.

  2. Selecciona la pestaña General.
  3. En la sección de Inicio, haz clic en Restaurar al valor por omisión.
    HomePage-Fx34Win HomePage-Fx34Mac HomePage-Fx34Lin
  4. Haz clic en Aceptar para cerrar la ventana de Opciones.Haz clic en Cerrar para cerrar la ventana de preferencias.Cerrar la ventana de preferencias. Cierra la página about:preferences.

Nota: Aquí encontrarás una lista de todas las plantillas disponibles. Además, puedes obtener más información sobre cómo utilizar el marcado {for} en este artículo.

¿Te resultó útil este artículo? Espera por favor...

Esta gente maravillosa ayudó a escribir este artículo: avelper. Tú también puedes ayudar, descubre cómo hacerlo.