Documentación

From The Document Foundation Wiki
Jump to: navigation, search

Lista de preguntas frecuentes con respuestas breves:

Equipo de documentación

El equipo de documentación en español es un grupo de voluntarios que se dedica, junto con los equipos de documentación de otros países, a la elaboración de documentación de LibreOffice.

El equipo de documentación se dedica principalmente a la elaboración de guías y manuales. Además de guías y manuales, también puede elaborar guías tipo cómo se hace, breves respuestas a preguntas frecuentes u otro documento que pueda ser útil a cualquier usuario de LibreOffice.

El equipo de documentación no se dedica a la traducción de la interfaz ni a la ayuda del programa. Estas tareas las realiza el equipo de Localización.

Actualmente, debido a la ausencia de autores en español, basamos nuestro trabajo en la documentación elaborada por otros equipos, principalmente en la documentación en inglés.

Cómo elaboramos la documentación

Tenemos, principalmente, dos formas de elaborar la documentación: la traducción y la actualización. Una vez elaborada la documentación de cualquiera de las dos formas, intentamos mejorarla con la revisión.

En la traducción, partimos de documentos en inglés y los traducimos al español. Al tiempo que hacemos las traducciones, vamos actualizando las imágenes y capturas de pantalla para que el contenido de las imágenes también se muestre en español.

En la actualización, partimos de documentos de versiones anteriores ya traducidos y, basándonos en las guías en otros idiomas, los actualizamos a una versión más nueva del programa. También actualizamos las imágenes. Esta forma de conseguir las guías requiere menos trabajo y suele ser más rápida.

Una vez que el documento ha sido traducido o actualizado, otras personas diferentes lo revisan. El objetivo es conseguir una documentación de calidad, sin errores ortográficos ni gramaticales y que sea fácilmente comprensible. La tarea de revisión se hace desde varias perspectivas: revisión de la traducción, revisión ortográfica y gramatical y revisión del contenido.

En la revisión de la traducción intentamos evitar fallos que se suelen cometer al traducir, tales como traducción de sustantivos como gerundios o empleo excesivo de la voz pasiva. La revisión ortográfica y gramatical pretende corregir aquellos errores que se hayan cometido en la traducción, generalmente suelen ser acentos olvidados y poco más; la revisión gramatical pretende evitar aquellos errores gramaticales que a veces se cometen por traducir literalmente del inglés. En la revisión del contenido se revisa que el texto esté claro, que las explicaciones sean comprensibles y que la traducción se corresponde con los menús o diálogos que se muestran en pantalla al ejecutar el programa.

Cómo puedes colaborar

Para colaborar no se necesitan requisitos especiales. Si sabes inglés u otros idiomas puedes colaborar en las traducciones. Si no tienes conocimientos de idiomas extranjeros puedes colaborar en las revisiones, actualizando las imágenes, comprobando que el contenido se ajusta a lo que se ve en pantalla o de muchas otras formas. Si nos dices tus capacidades seguro que podemos encontrar algo adecuado para ti.

Para colaborar no es necesario dedicar ni mucho ni poco tiempo, ni mucho ni poco trabajo, solo lo que puedas aportar. Además no tiene que ser siempre lo mismo, si ahora puedes dedicar menos tiempo, no importa o si puedes aportar más ¡estupendo!

Lo único que se requiere para colaborar es compromiso. No sirven de nada aquellas personas que manifiestan su intención de colaborar, piden usuario, permisos, incluso, a veces, intentan cambiar el sistema o la organización y a la hora de la verdad no colaboran en absoluto. Si no estás dispuesto a comprometerte, no nos hagas perder el tiempo.

También puedes colaborar elaborando pequeñas guías tipo cómo se hace, breves respuestas a preguntas frecuentes u otro documento que pueda ser útil a cualquier usuario de LibreOffice. Para ello no es necesario, si no quieres, unirte al equipo. Basta con que aportes estos documentos elaborados o traducidos por ti de cualquier forma que consideres conveniente: correo, enlace en la nube, etc. y nosotros no encargaremos de pubicarlos.

Otra forma de colaborar es enviando preguntas o sugerencias relacionadas con la documentación o con el equipo de documentación. No dudes en ponerte en contacto con nosotros por medio de nuestra lista.

Cómo unirse al equipo de documentación

Para unirse al equipo de documentación solo tiene que enviar un mensaje a la lista de correos documentation@es.libreoffice.org manifestando tu deseo de colaborar y cómo (qué función deseas realizar: autor, corrector, revisor, traductor, generador de imágenes…). En el mensaje escribe tu nombre real y el nombre de usuario que deseas utilizar.

En la lista recibirá más instrucciones. Las contestaciones a los mensajes que se envían a la lista se hacen a través de la lista, por lo que es conveniente que te suscribas antes de enviar tu mensaje. Para suscribirte envíea un mensaje a documentation+subscribe@es.libreoffice.org. El contenido del mensaje es irrelevante, puedes incluso enviarlo en blanco.

Personas que necesitamos

  • Autores: personas que quieran participar escribiendo documentación técnica o aquellos que ya la hayan escrito y quieran compartirla con nosotros.
  • Traductores: personas que colaboran traduciendo documentación escrita en otros idiomas. Aunque la documentación más abundante está escrita en inglés, también son útiles traductores de otros idiomas, especialmente francés y alemán.
  • Revisores: hay dos tipos, los que revisan la corrección ortográfica y gramática del documento, por un lado, y por otro lado los que comprueban que las descripciones y pasos descritos en los documentos se ajustan a los programas.
  • Editores: comprueban que el formato de los documentos es adecuado y que cumplen con los estándares de publicación de LibreOffice.
  • Indexadores: ayudan a crear índices adecuados para incluir en los documentos publicados.
  • Investigadores: investigan nuevas funcionalidades o posibilidades y las ponen en conocimiento del resto para que puedan ser documentadas.
  • Diseñadores gráficos: pueden colaborar en el diseño de portadas e ilustraciones de los documentos, en la elaboración de material de marketing o con gráficos o ilustraciones para las páginas web.
  • Diseñadores o programadores web: nos pueden ayudar a mejorar la imagen y funcionalidad de nuestras páginas web.
  • Cualquier otra habilidad: seguro que es útil si desea colaborar con nosotros.

Qué estamos haciendo ahora en el equipo de documentación

Actualizar las guías particualres de Calc, Base y Writer a la versión 6.2

En estos momentos estamos trabajando en la actualización de las guías específicas para Calc, Base y Writer. Ya hemos completado la actualización de la Guía de primeros pasos con LibreOffice a la versión 6.2.

Puedes ver lo que se ha publicado en la página de documentación de LibreOffice en español y en nuestro wiki.

Traducir la Guía de Calc

Se ha comenzado la traducción de la Guía de Calc 6.2

Traducir la Guía de Base

Se ha comenzado la traducción de la Guía de Base 6.2

Revisar la Guía de Writer

La Guía de Writer 6.0 está totalmente traducida, pero necesita revisión y la sustitución de todas las imágenes y capturas de pantalla.

Dónde publicamos la documentación

Publicamos la documentación en la página oficial de documentación de LibreOffice en español. También la publicamos en nuestro wiki

Documentos para los colaboradores

Es recomendable leer los siguientes documentos antes de colaborar con en equipo de documentación:

Listas de discusión para documentación de LibreOffice

La lista de discusión para documentación en español es documentation@es.libreoffice.org


La lista global de discusión para documentación (en inglés) es documentation@global.libreoffice.org


Lista de tareas para la documentación de usuario

Por favor, incorpore en la siguiente lista las cosas que desearía que se mejorarán en la documentación de usuario. Obviamente, no podemos hacer todo a menos que tengamos suficientes personas trabajando en ello, pero es muy útil tener una "lista de deseos": alguien puede ver la lista y decir "¡Yo puedo hacer eso!".

  • Guías de usuario en documentos ODT y PDF -- en proceso
  • Guías de usuario en el wiki
  • Guías de usuario en forma impresa -- planean hacerlo en Friends of OpenDocument [EN]
  • Preguntas y Respuestas (FAQs - en este wiki)
  • Guías de "Cómo se hace" (HowTos)
  • Tutoriales en formatos PDF y ODT
  • Tutoriales en video
  • Materiales de entrenamiento (¿Quizá hechos por otro grupo en la comunidad LibreOffice?)
  • Documentos dirigidos a públicos específicos, p.e. escritores técnicos, pequeñas empresas, estudiantes universitarios

Lista de tareas para documentación de desarrolladores

Por favor, agregue a esta lista las cosas que desea se incluyan en la documentación del desarrollador.

  • Empaquetamiento (.deb, .rpm, .dmg, .pisi,...)
  • UNO/LibreOffice Object Model (objetos, métodos y propiedades) ayudaría a desarrolladores de LibreOffice y macros. Algunos diagramas de la jerarquía del modelo de objetos ayudaría a los recién llegados a comenzar más rápido.
  • Flujo de trabajo del nivel de desarrollo incluyendo git, ejecutando soffice con el debugger y cuando construir todo/módulos.
  • FAQs para desarrolladores para las distintas fases del desarrollo. (Estas probablemente pertenecen a la sección de Desarrollo).