Cómo funciona la Base de Conocimiento

Vale. Esta es la versión larga de cómo funciona la Base de Conocimientos. Quizás quieras coger algún aperitivo o algo de beber antes de empezar a leer. ¡Incluso la tabla de contenidos es larga!

La Base de Conocimientos es un wiki con súper poderes

Compruébalo:

  • Marcado especial de wiki - Aunque para la mayoría de cosas utilizamos el marcado de MediaWiki (como la Wikipedia), nuestro wiki se ha diseñado especialmente para la Ayuda de Mozilla y utiliza un tipo de marcado determinado que se llama {for}, para que podamos ofrecer instrucciones específicas tanto para usuarios de Windows como de Mac.
  • Sistema de revisión - Queremos asegurarnos de que la gente obtiene la información correcta y más actual. Por eso, las ediciones de nuestros artículos tienen que ser revisadas y aprobadas antes de que lleguen al usuario final.
  • Traducciones - La mayoría de nuestros usuarios hablan un idioma distinto al inglés. Por eso, disponemos de un completo sistema de traducción para que todos los artículos de la Base de Conocimientos estén disponibles en otros idiomas.

Usuarios y contexto de la Base de Conocimiento

Con alrededor de 400 millones de usuarios de Firefox, la Base de Conocimientos debe estar redactada en un lenguaje general, no en uno específico lleno de terminología y términos informáticos. La mayoría de los artículos tratan sobre las distintas características de Firefox (pestañas, marcadores y sincronicazión) y sobre cómo solucionar problemas (cuelgues o problemas al cargar páginas web). No tenemos un artículo para cada característica, preferencia o problema. Al contrario, vemos lo que nos dicen los usuarios (en los comentarios de los artículos, en los foros de ayuda, en las páginas de visitas de los artículos, etc.) y utilizamos nuestra experiencia y juicio para ver qué temas debemos tratar.

¿Qué temas no se tratan en la Base de Conocimientos?

  • Trucos o hackeos para modificar un producto
  • Características más desarrolladas y avanzadas como consolas web o sus errores.
Nota: Los artículos sobre cómo solucionar un determinado problema suelen ser una excepción a esta regla. Si un problema común solo puede resolverse con un "hackeo", te explicaremos cómo hacerlo.

Organización de nuestro trabajo

¿Cuáles son nuestras prioridades?

Solemos trabajar en los artículos dependiendo de su popularidad. Este orden de popularidad representa las prioridades de los usuarios. Actualmente, los 20 artículos más visitados suponen más del 50% del tráfico total de la Base de Conocimientos. Hacer que nuestros 20 artículos más visitados sean más útiles puede ayudar a más personas que mejorar los 100 primeros artículos a la vez. Disponemos de una herramienta que registra los cambios que hay que hacer en este panel. Se ordena según el puesto que ocupa el artículo en el ranking, para que puedas distinguir fácilmente en qué deberías centrarte primero.

Excepciones:
Pero la popularidad no es nuestra única prioridad. También se tienen que tener en cuenta estas excepciones:

  • Problemas de último minuto - A veces, la mejor solución para algunos de los nuevos problemas que aparecen en el foro de ayuda es una actualización de los artículos de la Base de Conocimientos. Por ejemplo, un problema que afecta a los usuarios que utilizan Flash (un 99% de los usuarios de Firefox) tiene prioridad frente a un pequeño cambio de una característica en la próxima versión de Firefox.
  • Petición anticipada - A veces, se actualizan los artículos anticipándose a la aparición de una nueva característica o un cambio en ella. Ese artículo en cuestión puede que no tenga una buena posición en el ranking, pero estamos casi seguros, basándonos en nuestra experiencia y en los planes de marketing, de que, gracias a esos cambios, escalará puestos.
  • Documentación para dispositivos móviles - Dado que estos productos (Firefox para móviles, Firefox OS) tienen relativamente pocos usuarios, sus artículos no pueden "competir" con los artículos de escritorio de Firefox. Los artículos para estos productos deberían tenerse en cuenta únicamente en el contexto de la relativa demanda de ese tipo de documentación y de problemas relacionados con ese producto en concreto.
  • Artículos enlazados - Estos artículos enlazan a otros productos o a mozilla.org.

Localización:
Para poder minimizar el trabajo de los localizadores, nuestro objetivo es que las actualizaciones de los 20 artículos más visitados se hagan en un período de 6 semanas. Es decir, las actualizaciones menos importantes (las relacionadas con nuevas características, pequeños cambios o mejoras) se realizan en inglés pero no se informa inmediatamente de ellas al equipo de localización. Cuatro semanas antes del lanzamiento de un producto, se informará de los cambios en los 20 artículos más visitados que están listos para su localización. Intentamos que no se produzcan cambios en estos artículos durante las próximas 6 semanas. A veces, los problemas de última hora o algún error puede que requiera otro cambio en esos artículos. Cada seis semanas y basándonos en nuestra experiencia, creamos una lista de prioridades que sirve de guía para los localizadores. Aquí encontrarás un ejemplo.

¿Dónde comentamos los artículos?

Normalmente tenemos dos tipos de conversación sobre los artículos de la Base de Conocimientos:

  • Artículos individuales - Cada artículo tiene su propia pestaña de discusión. Los usuarios que estén registrados pueden dejar sus comentarios sobre los artículos y nosotros podemos discutir sobre qué revisiones necesita el artículo, alabar las revisiones y, en general, hablar de todo lo relacionado con el artículo.
    New Article Discussion
  • La Base de Conocimiento como un todo - Discutimos ideas y problemas con unas estrategias, políticas y software específicos de la Base de Conocimientos en los artículos.

¿Cómo mantenemos actualizados los artículos en la última versión de los productos de Mozilla?

Antes del lanzamiento de un nuevo producto de Mozilla (Firefox, Firefox para móviles, Firefox OS), existen cuatro fases o canales por los que debe pasar: son los llamados "canales de distribución". La futura versión pasa de un canal a otro cada seis semanas. Actualmente tenemos Nightly, Aurora, Beta y los canales de lanzamiento. Durante las primeras seis semanas está en el canal Nightly, donde se añaden nuevas características y soluciones a estos productos. A continuación, esa versión se desplaza al canal Aurora donde se siguen haciendo pruebas. Tras seis semanas en Aurora, pasa a Beta. Finalmente, tras seis semanas de pruebas en Beta, esa versión se convierte en la nueva versión de lanzamiento del producto. Para poder seguir ese proceso de cambios en los productos, la documentación escrita también sigue un ciclo de seis semanas.

doc schedule

Ciclo de desarrollo. Semanas 1 - 4

  • Localizar el canal Beta: Una vez que se han terminado todos los artículos (en el ciclo anterior), dispondremos de cuatro semanas para localizarlos antes de su lanzamiento. Será en ese momento cuando se informará de que las revisiones están listas para su localización y estas aparecerán en el Panel de Localización.
    • Nota: En las dos semanas previas a este paso puede que también se realicen actualizaciones basándose en la información que se tiene del último lanzamiento, que también se incluirá en este grupo de artículos que necesitan localización.
  • Borradores en el canal Aurora: Tenemos cuatro semanas para escribir nuevos artículos y realizar actualizaciones de los ya existentes. Seguiremos con atención el seguimiento del lanzamiento para saber qué cambios y adiciones hay que documentar.
  • Seguimiento en el canal Nightly: Seguiremos con atención el seguimiento del lanzamiento para saber qué cambios hay que hacer y qué se debe añadir. El seguimiento de las características de Firefox es un proceso ininterrumpido que continúa en la fase Beta. Sin embargo, una vez que llegue a Aurora, los principales cambios consistirán en la posible eliminación de una de las características.
  • Archivo: Dado que tanto nuestros productos como su documentación y servicios cambiarán con el lanzamiento de las nuevas versiones, utilizaremos el archivo para saber si hay artículos que están:
    • Desactualizados porque nuestros productos han cambiado.
    • Desactualizados porque reciben pocas visitas por parte de los usuarios y, por tanto, no se les considera de gran interés.

Ciclo de desarrollo. Semanas 5 y 6

  • Actualizar los lanzamientos: Se va a lanzar una nueva versión de los productos de Mozilla, por lo que, si es necesario, tendremos que poder hacer los ajustes necesarios en nuestra documentación basándonos en los comentarios que dejan los usuarios en los foros de ayuda.
  • Finalizar los artículos en el canal Beta: Una vez que se pasa del canal Aurora al Beta, disponemos de dos semanas para terminar esos artículos que aún están en borrador. Durante este tiempo:
    • Si es necesario, añadiremos capturas de pantalla y demostraciones en vídeo.
    • Revisaremos y aprobaremos los artículos.
    • Estableceremos la última revisión como lista para su localización.
  • Empezar a seguir el nuevo lanzamiento en el canal Nightly: Un nuevo lanzamiento estará ahora disponible en el canal Nightly.

¿Cómo me mantengo al día de lo que está pasando?

Mejorar los artículos

Mejorar los artículos de la Base de Conocimiento quizás sea un 90% del trabajo que hacemos. Con unos 200 artículos disponibles en la Base de Conocimientos, siempre hay algo que mejorar. Estas son tres formas posibles de mejorar un artículo:

  • Mantener los artículos actualizados – Las grandes actualizaciónes de los productos de Mozilla y sus servicios suelen implicar nuevas características y cambios en el funcionamiento de las ya existentes. Siempre es mejor si las instrucciones coinciden exáctamente con el funcionamiento del producto de que se trate.
  • Revisión o corrección – Algunos tienen una capacidad especial para detectar errores que se le pasan al corrector (¿Cuántos errores has visto hasta ahora en este artículo?). Por eso necesitamos tu ayuda.
  • Hacer que los artículos sean fáciles de entender
    • Encuentra otra forma de explicar algo que resulte complicado de entender o que no esté del todo claro.
    • Añade capturas de pantalla para ayudar a la gente a saber exáctamente a qué se refiere el texto. La mayoría de la gente quizá no sepa la diferencia entre la barra de direcciones, la barra de búsqueda o cualquier otra barra a no ser que tenga alguna pista.
    • Añade demostraciones de vídeo. Es la segunda mejor cosa que puedes hacer para facilitarle aún más el proceso a los usuarios.

¿Cuál es el proceso de edición de un artículo?

Como mínimo, lo que tienes que hacer es clic en "Editar Artículo", hacer algunos cambios y enviarlo para revisión. Este es el proceso completo:

  1. Ve a la sección Requiere cambios del Panel de la BC.
  2. De entre todos los comentarios que describen qué se necesita, elige un artículo. Amplia las opciones de Edición y echa un vistazo a la discusión para obtener más información esencial para este artículo.
  3. Edita el artículo. Para obtener información sobre el estilo, consulta el artículo Cómo escribir artículos de la Base de Conocimiento.
    • Utiliza el botón Vista previa de contenido para comprobar lo que has hecho.
  4. Haz clic en Enviar para revisión para guardar los cambios. Tu edición aparecerá en la sección Cambios sin revisar del Panel de la Base de Conocimientos.

Si hace mucho que un artículo está esperando revisión, puedes ponerte en contacto con Michael Verdi en el canal IRC de #sumo o via email.

Si el revisor no aprueba el artículo deberá dar sus razones y dejar un comentario en la página de "Discusión" del artículo. A veces, creará él mismo una nueva revisión basada en la tuya y añadirá o eliminará cosas.

Tú o cualquier otra persona podéis crear una nueva versión y añadir más cambios. Normalmente se necesitan varias revisiones para que todo esté bien.

Crear un nuevo artículo

Si crees que hay un artículo que deberíamos añadir a la Base de Conocimientos, así es como debes hacérnoslo saber:

Asegúrate de buscar bien en la BC para ver si ya hay un artículo sobre el tema que quieres tratar.
  1. Crea un nuevo artículo y rellena el formulario utilizando la fuente de otro artículo como guía.
  2. Crea un borrador con el contenido del artículo.
  3. Revisa tu trabajo haciendo clic en Vista previa de contenido.
  4. Haz clic en Enviar para revisión e incluye un pequeño comentario sobre tu trabajo antes de aceptar definitivamente.
    • Esto hará que el artículo aparezca en la sección correspondiente de la BC y la gente sabrá que necesita una edición o revisión.
    • El artículo no se hará público hasta que se revise y apruebe.

Estilo

Queremos que la Ayuda de Mozilla sea últil para todos los usuarios; es decir, nuestra intención es utilizar un lenguaje accesible para todos y no para una minoría que entiende de términos técnicos.

  • Estás escribiendo para una persona que no sabe cómo cambiar las preferencias o añadir un botón a la barra de herramientas si no sigue unas instrucciones paso a paso.
  • Tienes que asumir que hay gente que nunca ha cambiado los ajustes de fábrica del producto o de su sistema operativo.
  • Estilo de conversación a modo conversación. Utiliza un estilo informal y activo, parecido al que usas cuando estás hablando con alguien en persona.
  • Imágenes y vídeos – Utilizar imágenes y vídeos para explicar mejor el texto al que acompañan no es solo la mejor forma de ayudar a alguien, sino que también es una forma fácil y sencilla de incluir diferentes estilos de enseñanza y repeticiones.

Para más información, consulta el artículo Cómo escribir artículos de la Base de Conocimiento.

Marcado

Nuestro wiki utiliza una sintáxis MediaWiki y además incluye algunas herramientas especiales como botones de estilo, teclas, menús, etc. Para obtener una lista y algunos ejemplos, consulta la Tabla de Wikitexto.

{for}

El artículo Cómo utilizar "for" contiene información y ejemplos sobre cómo mostrar u ocultar información dependiendo de la versión de Firefox o el sistema operativo que utilices.

Plantillas

Contamos con una lista de plantillas que utilizamos en nuestros artículos para no tener que volver a escribir siempre los mismos pasos en las instrucciones. Así, también evitamos tener que volver a localizarlos y sincronizarlos en muchos artículos. Para saber en qué consisten y cómo funcionan, consulta el artículo Cómo usar las plantillas.

Capturas de pantalla y demostraciones de vídeo

Deberíamos asegurarnos de que los artículos están escritos para que se entiendan sin imágenes o vídeos. Aunque tanto las imágenes como las demostraciones de vídeos son muy importantes y suponen una gran ayuda para el texto del artículo, no son obligatorias. Los localizadores tienen libertad para añadirlas o eliminarlas según consideren necesario.

Prioridad en las versiones de escritorio

  1. Windows - Cerca del 90% de nuestros usuarios utilizan este sistema operativo, por lo que no hace falta más explicación. De ahora en adelante deberían hacerse las capturas de pantalla en Windows 7. Cuando se añada ayuda para usuarios de Windows XP, se añadirán capturas específicas para ellos.
  2. Mac - la versión actual es la 10.8 (Mountain Lion).
  3. Linux - utiliza Ubuntu para hacer las capturas de pantalla.

Dispositivos móviles

  1. Android - 4.0 Ice Cream Sandwich.

Añadir o eliminar artículos

Proponer nuevos artículos

Nuestra Base de Conocimientos es lo que hace que nuestra ayuda y nuestros esfuerzos por ayudar lleguen a cientos de millones de usuarios de Firefox. Lo más inteligente es responder a las dudas de nuestros usuarios sobre los productos de Mozilla y sus servicios escribiendo un nuevo artículo. Pero nada es gratis en esta vida. Tienen que escribirse, localizarlos y mantenerlos actualizados. Con tantas características y problemas documentados como tenemos, quizás sea mejor que nuestros colaboradores mejoren los artículos ya existentes. Antes de empezar a crear nuevos artículos como un loco, veamos algunas cosas que deberías tener en cuenta primero:

¿Necesitamos realmente este artículo?
Estas son las principales razones por las que añadimos nuevos artículos a la Base de Conocimientos, incluso si a veces es más útil actualizar o añadir cosas a artículos ya existentes.

  • Nuevas características - Cuando se trata de nuevas características que van a despertar el interés de muchos usuarios. Puede tratarse de un aspecto inherente de esa característica, del resultado de estrategias de márketing o enlaces internos a otros productos o ambas cosas a la vez.
  • Nuevos problemas - Problemas que han recibido muchos votos y suscitado nuevos hilos en el foro de ayuda.
  • Gran impacto - Problemas críticos y momentáneos que necesitan una nueva documentación temporal. Por ejemplo, Pogo.com y otras páginas Java no funcionan.

Archivar artículos

Periódicamente archivamos los artículos de la Base de Conocimientos para centrarnos en las necesidades más importantes y exigentes de nuestros usuarios. Dado que los lanzamientos de los productos de Mozilla se producen cada seis semanas, los problemas y características que necesitamos documentar para nuestros usuarios cambiarán con mayor frecuencia. Habrá muchos artículos (como Cómo usar los marcadores para guardar y organizar tus páginas favoritas o Cómo establecer la página de inicio) que permanecerán ahí durante mucho tiempo, pero también habrá otros que se volverán obsoletos o que ya no serán de interés para nuestros usuarios. La idea es contar con unos 200 artículos, lo que nos permitirá documentarlo todo con bastante precisión y localizarlos y mantenerlos.

Cómo funciona:
Los colaboradores que tengan permiso para revisar pueden marcar un artículo como obsoleto con tan solo editar la descripción del artículo. Esto hará que ese artículo desaparezca de todos los paneles (incluido el de localización) y de todas las búsquedas. Por el contrario, podrás seguir accediendo a ese artículo utilizando la búsqueda avanzada y, por supuesto, se mantendrá el enlace a ese artículo. Sin embargo, aparecerá una advertencia en la parte superior del artículo donde se explique que ese artículo puede estar desactualizado.

Archivar un artículo no es un proceso sin vuelta atrás. Una vez archivado, lo vigilamos de cerca para asegurarnos de que no era uno de los más populares. Si hay algún error, podemos volver a colocarlo en los paneles con tan solo hacer clic en una casilla de verificación.

Aspectos que hay que tener en cuenta antes de archivar un artículo:

  • Pocas visitas - Normalmente son aquellos artículos que tienen menos de 1500 visitas al mes.
  • Pocos informes recientes - Problemas que tienen relativamente pocos votos e hilos en el foro de ayuda.
  • Poco impacto - Eliminar un artículo no significa causar o agravar un problema.
  • Cambios en los productos y servicios - Casos en los que la solución a un problema o un cambio en el comportamiento del producto han hecho que otra característica o aspecto haya quedado obsoleto.

Guía para la revisión de los artículos

¡Madre mía! Este artículo es ya demasiado largo, así que la Guía para revisar artículos está en otro artículo aparte.

¿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.