Bandingkan Revisi

Estructura de un artículo de la Base de Conocimientos

Revisi 38038:

Revisi 38038 oleh avelper pada

Revisi 40510:

Revisi 40510 oleh avelper pada

Kata kunci:

Ringkasan hasil pencarian:

Tienes 160 caracteres y el título para que la gente sepa de qué va el artículo. Podríamos decir que es como un tweet o un anuncio de publicidad clasificado. Para más información: http://mzl.la/QNLUN5
Tienes 160 caracteres y el título para que la gente sepa de qué va el artículo. Podríamos decir que es como un tweet o un anuncio de publicidad clasificado. Para más información: http://mzl.la/QNLUN5

Konten:

[[Video:Anatomy Intro]] 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 [https://support.mozilla.org/en-US/kb/anatomy-of-a-knowledge-base-article/edit fuente del marcado]. <!-- ESTE ES UN COMENTARIO QUE NO SERÁ VISIBLE PARA EL LECTOR PORQUE EMPIEZA Y ACABA CON UNOS CARACTERES ESPECIALES: A veces, los autores de los artículos dejan notas de esta forma. En este artículo utilizaré estas notas para señalar y puntualizar cómo utilizamos las marcas del wiki. --> 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. ([[Use tabs to organize lots of websites in a single window|Aquí]] encontrarás un ejemplo). *Artículos que sirven para solucionar problemas: un breve resumen de los síntomas y posibles soluciones. ([[Flash 11.3 crashes|Este es un ejemplo]]). <!-- NOTA: En el párrafo anterior, los asteriscos, *, se utilizan para crear una lista desordenada. Además, un enlace a otro artículo suele aparecer así: [[Nombre del artículo]], pero en este caso añadimos el símbolo "|" y un nuevo nombre para que que quede así: [[Nombre del artículeo|nombre que quiero mostrar al lector]] --> __TOC__ <!-- NOTA: Así se hace una tabla de contenidos o índide para el artículo --> =Cómo estructurar el artículo= <!-- NOTA: Este es un título de nivel 1 --> 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 [[Use Tab Groups to organize a lot of tabs|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. <!-- NOTE: En este párrafo anterior encontrarás otro ejemplo de enlace a un artículo que no muestra el título tal cual: cambia el texto que se muestra al lector. --> ==Escribe encabezados de sección descriptivos para que los lectores puedan echar un vistazo rápido== <!-- NOTA: Este es un encabezado de nivel 2. ¿Adivinas cómo es el encabezado de nivel 3? --> 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 [[How to set the home page]]: <!-- Esta frase de arriba es otro ejemplo de un enlace a un artículo. --> # Abre la página web que quieres que sea tu página de inicio. # Haz clic en el icono que se encuentra a la izquierda de la dirección web, arrástralo hasta el botón de Inicio y suéltalo. #Haz clic en {button Sí} para confirmarla como tu página de inicio. <!-- NOTA: Look at the wiki markup in this step that creates a special style to denote a button on the screen. --> ==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. {note}'''Truco:''' Échale un vistazo a la [https://support.mozilla.org/en-US/kb/anatomy-of-a-knowledge-base-article/edit funte del wiki] para ver cómo se hace (por favor, no cambies el artículo).{/note} <!-- NOTA: Las notas no tienen porqué llamarse siempre "Notas". A veces, pueden ser trucos o ideas, así que simplemente las llamamos así. --> {for win} <!-- NOTA: Estas instrucciones van dirigidas solo para usuarios de Windows. --> #En la parte superior de la ventana de Firefox, haz clic en {button Firefox}, ({menu Herramientas} en Windows XP) y selecciona {menu Opciones}. # Selecciona la pestaña {menu General}. # En la sección de Inicio, haz clic en {button Restaurar al valor por omisión}. #:[[Image:Home page Win3]] # Haz clic en {button Aceptar} para cerrar la ventana de Opciones. {/for} {for mac} <!-- NOTA: Estas instrucciones van dirigidas exclusivamente a usuarios de Mac. --> #En la barra de menú, haz clic en {menu Firefox} y selecciona {menu Preferencias...} # Selecciona la pestaña {menu General}. # En la sección de Inicio, haz clic en {button Restaurar al valor por omisión}. #:[[Image:Home page Mac3]] #Cierra la ventana de Preferencias. {/for} {for linux} <!-- NOTA: Estas instrucciones van dirigidas exclusivamente a usuarios de Linux. --> #En la parte superior de la ventana de Firefox, haz clic en {menu Editar} y selecciona {menu Preferencias}. # Selecciona la pestaña {menu General}. # En la sección de Inicio, haz clic en {button Restaurar al valor por omisión}. #:[[Image:Home page Lin3]] # Haz clic en {button Cerrar} para cerrar la ventana de Preferencias. {/for} ===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: {note}'''Truco:''' Échale un vistazo a la [https://support.mozilla.org/en-US/kb/anatomy-of-a-knowledge-base-article/edit fuente del wiki] para ver cómo se hace (por favor, no cambies el artículo).{/note} # [[T:optionspreferences]] # Selecciona la pestaña {menu General}. # En la sección de Inicio, haz clic en {button Restaurar al valor por omisión}. #:{for win}[[Image:Home page Win3]]{/for}{for mac}[[Image:Home page Mac3]]{/for}{for linux}[[Image:Home page Lin3]]{/for} # [[T:closeOptionsPreferences]] <!-- NOTA: En esta sección, las plantillas incluyen instrucciones comunes para todos los sitemas operativos. Así que, lo único por lo que nos tenemos que preocupar es por las capturas de pantalla. Es importante que recuerdes que cuando utilices el marcado "for" en una lista, solo puedes utilizarlo UNA VEZ EN CADA PASO. NO PUEDES CREAR UN PASO PARA UN SISTEMA OPERATIVO Y NO HACERLO PARA LOS OTROS SISTEMAS. SI LO HACES, SE ROMPERÁ LA NUMERACIÓN. EN ESE CASO, TENDRÁS QUE HACER LISTAS SEPARADAS COMO EN EL EJEMPLO DE LA SECCIÓN ANTERIOR. Para más información, consulta el artículo http://support.mozilla.org/kb/how-to-use-for --> {note}'''Nota:''' [https://support.mozilla.org/en-US/kb/category/60 Aquí] encontrarás una lista de todas las plantillas disponibles. Además, puedes obtener más información sobre cómo utilizar el marcado <nowiki>{</nowiki>for<nowiki>}</nowiki> en este [[How to use For|artículo]].{/note}
[[Video:http://youtu.be/glEfWcibcy0]] 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 [https://support.mozilla.org/en-US/kb/anatomy-of-a-knowledge-base-article/edit fuente del marcado]. <!-- ESTE ES UN COMENTARIO QUE NO SERÁ VISIBLE PARA EL LECTOR PORQUE EMPIEZA Y ACABA CON UNOS CARACTERES ESPECIALES: A veces, los autores de los artículos dejan notas de esta forma. En este artículo utilizaré estas notas para señalar y puntualizar cómo utilizamos las marcas del wiki. --> 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. ([[Use tabs to organize lots of websites in a single window|Aquí]] encontrarás un ejemplo). *Artículos que sirven para solucionar problemas: un breve resumen de los síntomas y posibles soluciones. ([[Flash 11.3 crashes|Este es un ejemplo]]). <!-- NOTA: En el párrafo anterior, los asteriscos, *, se utilizan para crear una lista desordenada. Además, un enlace a otro artículo suele aparecer así: [[Nombre del artículo]], pero en este caso añadimos el símbolo "|" y un nuevo nombre para que que quede así: [[Nombre del artículeo|nombre que quiero mostrar al lector]] --> __TOC__ <!-- NOTA: Así se hace una tabla de contenidos o índide para el artículo --> =Cómo estructurar el artículo= <!-- NOTA: Este es un título de nivel 1 --> 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 [[Use Tab Groups to organize a lot of tabs|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. <!-- NOTE: En este párrafo anterior encontrarás otro ejemplo de enlace a un artículo que no muestra el título tal cual: cambia el texto que se muestra al lector. --> ==Escribe encabezados de sección descriptivos para que los lectores puedan echar un vistazo rápido== <!-- NOTA: Este es un encabezado de nivel 2. ¿Adivinas cómo es el encabezado de nivel 3? --> 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 [[How to set the home page]]: <!-- Esta frase de arriba es otro ejemplo de un enlace a un artículo. --> # Abre la página web que quieres que sea tu página de inicio. # Haz clic en el icono que se encuentra a la izquierda de la dirección web, arrástralo hasta el botón de Inicio y suéltalo. #Haz clic en {button Sí} para confirmarla como tu página de inicio. <!-- NOTA: Look at the wiki markup in this step that creates a special style to denote a button on the screen. --> ==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. {note}'''Truco:''' Échale un vistazo a la [https://support.mozilla.org/en-US/kb/anatomy-of-a-knowledge-base-article/edit funte del wiki] para ver cómo se hace (por favor, no cambies el artículo).{/note} <!-- NOTA: Las notas no tienen porqué llamarse siempre "Notas". A veces, pueden ser trucos o ideas, así que simplemente las llamamos así. --> {for win} <!-- NOTA: Estas instrucciones van dirigidas solo para usuarios de Windows. --> #En la parte superior de la ventana de Firefox, haz clic en {button Firefox}, ({menu Herramientas} en Windows XP) y selecciona {menu Opciones}. # Selecciona la pestaña {menu General}. # En la sección de Inicio, haz clic en {button Restaurar al valor por omisión}. #:[[Image:Home page Win3]] # Haz clic en {button Aceptar} para cerrar la ventana de Opciones. {/for} {for mac} <!-- NOTA: Estas instrucciones van dirigidas exclusivamente a usuarios de Mac. --> #En la barra de menú, haz clic en {menu Firefox} y selecciona {menu Preferencias...} # Selecciona la pestaña {menu General}. # En la sección de Inicio, haz clic en {button Restaurar al valor por omisión}. #:[[Image:Home page Mac3]] #Cierra la ventana de Preferencias. {/for} {for linux} <!-- NOTA: Estas instrucciones van dirigidas exclusivamente a usuarios de Linux. --> #En la parte superior de la ventana de Firefox, haz clic en {menu Editar} y selecciona {menu Preferencias}. # Selecciona la pestaña {menu General}. # En la sección de Inicio, haz clic en {button Restaurar al valor por omisión}. #:[[Image:Home page Lin3]] # Haz clic en {button Cerrar} para cerrar la ventana de Preferencias. {/for} ===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: {note}'''Truco:''' Échale un vistazo a la [https://support.mozilla.org/en-US/kb/anatomy-of-a-knowledge-base-article/edit fuente del wiki] para ver cómo se hace (por favor, no cambies el artículo).{/note} # [[T:optionspreferences]] # Selecciona la pestaña {menu General}. # En la sección de Inicio, haz clic en {button Restaurar al valor por omisión}. #:{for win}[[Image:Home page Win3]]{/for}{for mac}[[Image:Home page Mac3]]{/for}{for linux}[[Image:Home page Lin3]]{/for} # [[T:closeOptionsPreferences]] <!-- NOTA: En esta sección, las plantillas incluyen instrucciones comunes para todos los sitemas operativos. Así que, lo único por lo que nos tenemos que preocupar es por las capturas de pantalla. Es importante que recuerdes que cuando utilices el marcado "for" en una lista, solo puedes utilizarlo UNA VEZ EN CADA PASO. NO PUEDES CREAR UN PASO PARA UN SISTEMA OPERATIVO Y NO HACERLO PARA LOS OTROS SISTEMAS. SI LO HACES, SE ROMPERÁ LA NUMERACIÓN. EN ESE CASO, TENDRÁS QUE HACER LISTAS SEPARADAS COMO EN EL EJEMPLO DE LA SECCIÓN ANTERIOR. Para más información, consulta el artículo http://support.mozilla.org/kb/how-to-use-for --> {note}'''Nota:''' [https://support.mozilla.org/en-US/kb/category/60 Aquí] encontrarás una lista de todas las plantillas disponibles. Además, puedes obtener más información sobre cómo utilizar el marcado <nowiki>{</nowiki>for<nowiki>}</nowiki> en este [[How to use For|artículo]].{/note}

Kembali ke Riwayat