Introduccion

Ayudando con la documentación es una de las maneras más sencillas de involucrarse con la fantástica comunidad de Ubuntu si no te has relacionado con la computación a nivel técnica. Una buena documentación es fundamental para el proyecto Ubuntu, ya que ayuda a nuestros usuarios a superar las dificultades que pueden encontrar si están probando Ubuntu por primera vez, o han estado usando Ubuntu por algún tiempo.

Existen principalmente dos tipos de documentación en la comunidad Ubuntu. Estas son:

• Documentación del sistema - la documentación que viene con cada sistema Ubuntu, Kubuntu, Xubuntu y Edubuntu. Incluye la guía de la versión de servidor de Ubuntu.

• Documentación del wiki - La ayuda del wiki es un recurso escrito por la comunidad que cualquiera puede editar.

Ambos tipos de documentación se adecuan perfectamente a un Jam. Como un colaborador inicial de la documentación de Ubuntu, la documentación del wiki es el mejor lugar para empezar. Todos pueden editar la documentación del wiki, y el formato usado para crear la documentación es sencillo y fácil de entender. La documentación del sistema no es libre de editar para todos poque el material se encuentre presente en el centro de ayuda de cada escritorio de Ubuntu y se ha adoptado un escrito control de calidad. Sin embargo, también es fácil de aprender como contribuir a la documentación del sistema.

Requisitos

Tutor(es) - Alguien con experiencia en documentación técnica que pueda manejar preguntas sobre el estilo de escritura o las herramientas y revisar los cambios. (El tutor debe contar con experiencia con la documentación de Ubuntu y el proceso de documentación de Ubuntu.)

Fecha programada - Un día con algo de tiempo disponible. Por ejemplo, el LoCo de Michigan tuvo programado desde mediodía hasta las 8pm un Sábado. El progreso será más lento de lo esperado, así que dispon de mucho tiempo.

Lugar - Un lugar de reunión con conectividad de red, energía para todos, ay algún espacio donde poder descansar por unos momentos.

Documentation Playbook (optional) - We have a generic sheet that you can print out and hand out to attendees that people can follow along with the workflow for the system documentation - see System Documentation Playbook.

Jams Virtuales - No es requisito contar con una ubicación física para realizar un jam, sin embargo si es posible reunirse en un mismo lugar, es mucho más recomendable. Gran parte del trabajo de documentación en la comunidad de Ubuntu es realizado por voluntarios alrededor del mundo, así que la colaboración virtual es común. Un jam virtual puede ser recomendado si no se cuenta con un tutor disponible para un jam físico y preferirías preguntar a uno de los miembros del DocumentationTeam para que actúe como tutor. Si se desea realizar un jam virtual, se sugiere lo siguiente:

1. Suscribirse a la lista de correo e indicar el día y la fecha del Jam.

2. Discutir la planificación de la Jam en la lista de correo
3. Reunirse para el Jam en el canal #ubuntu-doc en la red IRC de Freenode

Preparación

La preparación no es escencial, pero se ahorrará tiempo y hará que en el jam se pase más tiempo trabajando en mejorar la documentación en lugar de aprender sobre cómo trabajar.

A los participantes, se les debe pedir que lean las páginas del DocumentationTeam en la documentación del sistema y la documentación de wiki.

Las páginas claves para la documentación del sistema inician en DocumentationTeam/SystemDocumentation y las páginas claves para la documentación del wiki inician en DocumentationTeam/Wiki. Para aquellos que desean trabajar en el wiki, recomendamos leer la guía del wiki.

Celebrando la sesión

Sesión de introducción

• Presente la documentación del sistema y la documentación del wiki y evalúe el nivel de preparación que se ha hecho.
• Si es necesaria una revisión de las herramientas, presenta las herramientas usadas.
• Discuta si el jam se centrará en la documentación del wiki, la documentación del sistema o un poco de ambas.
• Planee algunas tareas que serán realizadas pr diferentes colaboradores (mire debajo).

Tareas

Las tareas del DocumentationTeam estñan listadas en las siguientes páginas:

• Tareas del wiki

• Tareas de la documentación del sistema

Lea esas páginas para ejemplos de las cosas que puede hacer en un Jam. Sientase libre de elegir. Dependiendo el nivel de confianza y cuan familiarizado está con las herramientas, puede que desee:

• Revisar las páginas del wiki o la documentación del sistema para identificar errores y reportarlos
• Identificar errores existentes y corregirlos

• Limpie páginas del wiki que han sido marcadas con etiquetas y en las que se necesita trabajar

• Escriba nuevos documentos con asuntos que no existen aún (no olvide planificar la estructura primero)

Es posible que desee escoger un tema en particular para el Jam. Por ejemplo, los participantes de un jam pueden trabajar como equipo planificando un nuevo documento y dividirse la sección individualmente entre los diferentes participantes. O puedes enfocarte en un área particular del wiki en la que se necesite trabajar. Si usted está planeando un jam temático, coméntelo por adelantado en la lista de correo del equipo de documentación de modo que su trabajo no duplique el trabajo que podrían estar haciendo actualmente otros.

Flujo de trabajo

• Como personas trabajando en documentos o páginas de wiki, mantenga un seguimiento del número de documentos en los que se ha trabajado. Esto puede ser hecho con notas de tomboy, un marcador en una pizarra, o cualquier otra manera. Es importante que tenga algún número para así, poder medir las mejoras y el progreso que va teniendo en más Jams.
• Intente agrupar a personas que tienen intereses similares en grupos, de este modo pueden intentar trabajar en documentos juntos y responder preguntas en grupo.

Herramientas & Información de ayuda

Todo la información necesaria se puede encontrar en la página del DocumentationTeam y las páginas enlazadas desde allí, sientase libre de contactar al equipo si tiene preguntas. Encuentre ayuda en #ubuntu-doc.

CategoryJam