Cómo escribir guías de

usuario de LO
Sugerencias para autores, revisores y editores
http://www.odfauthors.org/
Derechos de autor
Este documento tiene derechos de autor © 2010–2016 por sus colaboradores, tal como
aparecen en la lista en la sección titulada Colaboradores. Puede distribuirse o modificarse
bajo los términos de la GNU General Public License, versión 3 o posterior, o la Creative
Commons Attribution License, versión 4.0 o posterior.
Todas las marcas registradas que aparecen dentro de esta guía pertenecen a sus dueños
legítimos.

Colaboradores
Daniel Carrera Jean Hollis Webe Janet Swisher
Gary Schnabl Juan Carlos Sanz Cabrero Carlos Martínez

Comentarios y sugerencias
Por favor, dirija cualquier clase de comentario o sugerencia acerca de este documento a:
documentation@es.libreoffice.org
Nota: todo lo que envíe a la lista de correo, incluyendo su dirección de correo y cualquier otra
información personal que escriba en el mensaje se archiva públicamente y no puede ser
borrada

Fecha de publicación y versión del programa

Versión en español publicada el 22 de noviembre de 2016

http://www.odfauthors.org/
Contenidos
Derechos de autor.............................................................................................................................i
Colaboradores..............................................................................................................................i
Comentarios y sugerencias...........................................................................................................i
Fecha de publicación y versión del programa..............................................................................i
Introducción.....................................................................................................................................1
Formas de ver un documento...........................................................................................................1
Contenido....................................................................................................................................1
Estructura....................................................................................................................................1
Alternativas a la prosa......................................................................................................................2
Proceso de revisión y edición......................................................................................................2
Ejemplo de listas de viñetas y listas numeradas..........................................................................3
Diagramas, diagramas de flujo y árboles lógicos........................................................................3
Formato (uso)...................................................................................................................................4
Lenguaje de género neutral.........................................................................................................4
Qué no hacer...........................................................................................................................4
Qué hacer................................................................................................................................4
Títulos.....................................................................................................................................5
Acentuar lo importante en una frase............................................................................................5
Ejemplos.................................................................................................................................5
Sugerencias para revisores...............................................................................................................5
Grabe sus cambios.......................................................................................................................5
Utilice “Comentario” para hacer comentarios.............................................................................5
Separe diferentes tipos de revisión..............................................................................................6
Sugerencias para autores..................................................................................................................6
Recursos...........................................................................................................................................7
Resources.........................................................................................................................................7
English language references........................................................................................................7
Technical writing and editing......................................................................................................7
Writing in general........................................................................................................................8

Cómo escribir guías de usuario de OOo i

Introducción
Este documento proporciona sugerencias para mejorar su trabajo como autor, revisor o editor
de guías de usuario de LibreOffice. Debería ser leído conjuntamente con la Guía de Estilo.
Los términos revisor y editor generalmente se usan indistintamente en este documento. En la
publicación técnica corporativa tradicional, un editor es un tipo de revisor, mientras que un
revisor es un experto en la materia. En otras palabras es quien verifica la corrección técnica de
un documento. En el grupo de los voluntarios del mundo de Código Abiertos de LibreOffice, la
misma persona cubre a menudo ambos trabajos.

Formas de ver un documento

Se puede ver un documento de tres formas diferentes:
• Contenido: ¿Funciona la aplicación realmente de la manera que el dice el documento?
¿Las características están descritas completa y correctamente?
• Estructura: ¿Tiene sentido la organización del documento?, ¿Es el esquema claro?,
¿Hay alguna manera mejor de explicar un concepto en particular?
• Formato: ¿Tiene el documento un uso adecuado de la gramática y la puntuación?¿Usa
las plantillas y los estilos adecuadamente?
Cuando alguien piensa en el proceso de “editar”, normalmente se refiere a la acción de copiar-
editar, lo que corresponde a la vista del formato. Pero para un proyecto como la Guía de
Usuario donde la revisión del contenido y la revisión de la estructura (también llamada edición
sustantiva) son componentes importantes y necesarios y en consecuencia los autores deberían
estar preocupados por esos tres aspectos al trabajar con sus documentos.

Contenido
Intente verificar los aspectos técnicos que existan en el documento. En algunos casos podría
requerir alguna investigación (tal como la de preguntar a los desarrolladores para recibir mayor
o mejor información. Por ejemplo, para averiguar si el componente de Base de LO 3.0 puede
funcionar con cualquier Ambiente de Código Abierto de Java). De todas formas, en la mayoría
de los casos, se puede comprobar si los diferentes aspectos tratados son correctos o no,
utilizando la aplicación.
● ¿Corresponden los nombres de los elementos (menús, iconos, opciones, cajas de diálogo y
ventanas) con los que aparecen en la aplicación?
● ¿Corresponden los pasos de los procedimientos con lo que ocurre en la aplicación?
● ¿Falta algún paso?
● ¿El nivel de los detalles, es apropiado para el usuario típico (las explicaciones son
extensivas o concisas )?

Estructura
● Compruebe la estructura del documento.
● ¿Es clara la estructura del documento?
● ¿Falta algo que debería ser cubierto?
● ¿La explicación tiene sentido?

Cómo escribir guías de usuario de OOo 1

● ¿Está claro el esquema?
● ¿Hay alguna manera mejor de explicar este concepto?
Cuando sea necesario, los revisores deberían añadir material nuevo o más actualizado( al
revisar el material existente, no conformarse con escribir una nota constatando que “Esto
necesita más trabajo”. Sin embargo, si tiene preguntas (por ejemplo, si algo no está claro) y no
conoce la respuesta, es útil señalar el problema pidiendo ayuda para resolver el problema.

Alternativas a la prosa
“Todo está en el manual”
¿Cuantas veces se ha leído esa frase como respuesta a una pregunta? En el mundo de
Código Abierto tenemos la abreviatura de RFTM, que son las siglas de la frase inglesa de
“Read The Fine Manual” (“Lea el excelente manual”) (aunque algunos hacen que la F
corresponda a un adjetivo (Fucking) diferente).
Una y otra vez los usuarios son incapaces de encontrar lo que necesitan saber, aún cuando
esté en la documentación. Antes de culpar al usuario, considere como se presenta el material.
Algunas veces la prosa tradicional no es la mejor manera para transmitir un concepto (incluso
aunque esté bien escrita). Algunas alternativas a considerar son:
• Listas de viñetas y numeradas.
• Tablas y matrices.
• Diagramas, gráficos de flujo y árboles lógicos.
• Ilustraciones y gráficos.
Probablemente le resulten familiares estos conceptos. Por lo tanto no los vamos a discutir
excepto por una breve nota acerca de la diferencia entre listas de viñetas y listas numeradas:
• Las listas numeradas se usan para series secuenciales de acciones o eventos. Por
ejemplo al hacer una lista de los pasos ordenados en un procedimiento.
• Las listas de viñetas se usan para listas sin secuencias. Por ejemplo, para hacer listas de
las diferentes formas de realizar una tarea o, también, una serie de acciones que no
necesita realizarse un un orden particular.
Los siguientes ejemplos ilustran el uso de algunas alternativas.

Proceso de revisión y edición

El proceso de revisión profunda es muy importante para las Guías de usuario de LibreOffice.
Un documento comienza su vida cuando se hace “visible”. Mas el proceso de trabajo se inicia
desde cuando el autor, a partir de una idea o de un tema, empieza a escribir hasta el momento
de la publicación final del documento. Cuando el autor desea una revisión, lógicamente envía
su documento a un “revisor”, quien a continuación, lleva a cabo las revisiones de estilo,
gramática, ortografía, introduce ilustraciones relevantes al tema etc. etc. En otras palabras,
realiza el primer paso de correcciones y adiciones. Luego de éste proceso el documento
pasará a un trabajo final de ediciones. Donde el editor realiza correcciones más detalladas y
definitivas.
Cuando el documento ya ha pasado este estadio final el editor, podrá colocar el documento
revisado y editado en la carpeta adecuada. El editor, informará al autor, a través de la lista, el
resultado de los trabajos anteriores cambiando el estado del documento como “visible”.

Cómo escribir guías de usuario de OOo 2

Ejemplo de listas de viñetas y listas numeradas
El proceso de revisión profunda es muy importante para las guías de usuario de LibreOffice. La
revisión profunda consiste en las siguientes fases:
1) Un documento comienza su vida como “visible”. Esto quiere decir que su autor esta
trabajando en él.
2) Cuando esta listo para la revisión, el autor en envía el documento (estado > enviar).
3) El revisor descarga el archivo y realiza las ediciones. Cuando ya lo ha hecho, el revisor:
• Carga el archivo editado a la carpeta apropiada.
• Informa al autor a través de la lista.
• Vuelve a poner el documento en estado “visible”.

Diagramas, diagramas de flujo y árboles lógicos

Un diagrama bien diseñado puede añadirse información a una explicación. Considere este
ejemplo:

Estado visible
Autor
Escribe documento.
Envía

Edita y sugiere.
retira

Revisor
Carga el archivo editado.
Informa al autor.
Estado de
espera
Figura 1. Proceso de revisión.
Advierta que en este ejemplo el diagrama no contiene toda la información necesaria para
completar el proceso (por ejemplo “¿dónde cargo el archivo?”). Por lo tanto este diagrama
sería usado en adición a otra forma de explicación.

Cómo escribir guías de usuario de OOo 3

Formato (uso)
Esta sección explica con más detalle dos de los muchos asuntos de uso, el cual es un aspecto
del formato de un documento. Para información sobre puntuación y gramática consulte una
referencia general para el español. Para información de uso de la plantilla de guía de usuario
de ODFAuthors y estilos, refiérase al Template How-to.

Lenguaje de género neutral

Usar lenguaje de género neutral no es solo cuestión de “corrección política”. Nuestro objetivo
es el de presentar información de una forma clara y compresible. Si el documento es ambiguo,
ofensivo o frustrante para parte de los usuarios, esto interferirá con la comunicación clara y las
posibilidades del uso de los componentes de LibreOffice.
Usar lenguaje de género neutral no significa que se debe usar una gramática incorrecta, frases
extrañas (como él o ella) o palabras inventadas como él/ella. Frases incorrectas o artificiosas
no son partes de los objetivos de la escritura de género neutral.

Qué no hacer
• No use él como pronombre genérico; úselo sólo para referirse a hombres o chicos.
• No use ella pronombre genérico; úselo sólo para referirse a mujeres o chicas.
• No use ellos como pronombre singular su forma esta plural. Este uso está ganando
aceptación pero es ampliamente visto como incorrecto.1
• Evite el uso de él o ella y él/ella.
• No use substantivos con atributos feminizados (miembras) cuando el género del
substantivo es neutro. En otras palabras de uso para ambos sexos.

Qué hacer2
A continuación se dan unas sugerencias que pueden usar:
Sortee el problema del género cuando sea posible. Por ejemplo cuando se está dando
información de procedimientos o instrucciones, normalmente se dirige directamente al lector,
de manera que puede usar:
El modo imperativo [Haga ...(seguido de las instrucciones a seguir)].
Segunda persona (usted) en vez de tercera persona (él, el usuario)
Modo imperativo:
No Para iniciar una sesión, el usuario debe introducir su nombre de usuario y su
contraseña.
Sí Para iniciar una sesión, introduzca su nombre de usuario y su contraseña
Sí Para iniciar una sesión, usted debe introducir su nombre de usuario y su
contraseña.

1 N. del T.: Esto ocurre sólo en idioma inglés.

2 N. del T.: La mayoría de los ejemplos de la versión original no causan problemas en español puesto
que los posesivos que en inglés son diferentes para cada sexo (his/her) en español son iguales para
ambos sexos (su de el o de ella), por eso en la traducción algún ejemplo puede parecer absurdo. Eso
me ha llevado a eliminar de la traducción aquellos ejemplos que serían totalmente incoherentes o sin
sentido en español.

Cómo escribir guías de usuario de OOo 4

En los ejemplos, use una mezcla de nombres y escenarios masculinos y femeninos. En este caso se
puede referir a Juan como él y a María como ella.

Títulos
Algunos títulos son neutrales al género (ingeniero, asistente, gerente), pero otras veces puede
tener que buscar un nombre alternativo de género neutral (por ejemplo “representante de
ventas” en vez de “vendedor”).

Acentuar lo importante en una frase.

La escritura debe ser directa, clara y concisa. Por ejemplo, puede cambiar las sentencias que
contienen esto es o hay por versiones más directas ya que esas frases distraen al lector de la
parte importante del mensaje.

Ejemplos
No Hay una cuota de $150 por este curso.
Sí La cuota por el curso es de $150.

No Hay botones de navegación en la parte superior de la pantalla.

Sí Los botones de navegación están en la parte superior de la pantalla.
Sí Utilice los botones de navegación que aparecen en la parte superior de la pantalla.

No Hay tres opciones para insertar una imagen...

Sí Las opciones para insertar una imagen son...

Esta es la idea. Estos ejemplos no son complicados de cambiar, pero otras veces son mucho
más difíciles; a menudo los cambios requieren reescribir más de una frase en la que estas
palabras están implicadas.

Sugerencias para revisores

Aquí tiene una lista de cosas que hacer cuando revise o edite un capítulo de las guías de
usuario.

Grabe sus cambios

Asegúrese de grabar sus modificaciones cuando revise o edite un documento. El autor puede
así ver fácilmente lo que ha cambiado y aceptar o rechazar sus cambios.
Para grabar sus modificaciones haga clic en Editar > Seguimiento de cambios > Grabar
cambios (quizá también quiera utilizar Editar > Seguimiento de cambios > Mostrar
cambios, pero tenga en cuenta que mostrar los cambios puede modificar los saltos de página)

Utilice “Comentario” para hacer comentarios

Si se desea hacer algún comentario acerca de un párrafo o de una sección, no se necesita
hacer modificaciones directas en el texto. Inserte sencillamente un “comentario” al margen del
documento evitando así el poner su comentario directamente en el texto del documento. Use la
característica de insertar un “Comentario”: elija el menú Insertar > Comentario y escriba sus
comentarios en el cuadro. Rellene previamente las iniciales del usuario en Herramientas >

Cómo escribir guías de usuario de OOo 5

Opciones > LibreOffice > Datos de Usuario para que se añadan sus iniciales y fecha a sus
comentarios, puesto que varios revisores puede añadir textos al mismo comentario.

Separe diferentes tipos de revisión

No intente arreglar todo en una pasada. Haga varias pasadas y en cada pasada compruebe
algo diferente.
• Evite corregir o hacer revisión de la estructura mientras revisa el contenido, eso le
distraerá y retrasará.
• Evite corregir o revisar el contenido cuando haga revisión de la estructura, eso le
distraerá y retrasará.
• Evite hacer revisión de la estructura o revisiones de contenido cuando está
corrigiendo, eso le distraerá y retrasará.
• Puede hacer diferentes pasadas para corregir diferentes aspectos, como gramática
en una pasada y puntuación en otra.
Hay personas que prefieren comprobar primero elementos simples (como puntuación o uso de
estilos) de modo que esas cosas no les distraigan cuando hagan cambios importantes. Otras
prefieren hacer primero los cambios importantes de modo que no gasten tiempo en corregir
aquello que después modificarán o borrarán. Elija la estrategia que mejor se ajuste a su
método de trabajo.
Otras sugerencias
• Edite en pequeñas dosis y haga descansos frecuentes. Divida la tarea en partes
manejables. No edite durante más de una hora sin tomar un descanso.
• Intente leer el contenido solo una vez; lea por encima cuando busque otros problemas
en otras pasadas.
• Busque símbolos que vayan en pares – paréntesis, corchetes y comillas por ejemplo.
Los escritores olvidan a menudo el segundo signo del par.
• Lea la copia desordenadamente o hacia atrás. Considere leer los párrafos o las páginas
desordenadas. Leyendo hacia atrás le ayuda a concentrarse en cada palabra como
grupo de letras en vez de en su significado dentro de la frase.

Sugerencias para autores

Aquí tiene algunas sugerencias para ayudarle a escribir un documento.
• Empiece escribiendo sobre el tema que usted piense que es más fácil para poder empezar.
No es necesario que empiece escribiendo por el principio del documento y siga en una
secuencia hasta el final.
• Algunas personas les gusta crear un guión primero, pero otras prefieren escribir algunas
notas de texto para ordenarlas después. Elija el método más familiar para usted. De todos
modos el crear un guión, en algún momento, durante el proceso de la redacción del
documento, suele ser una buena idea. Le puede ayudar a asegurarse de que ha cubierto
todos los temas que quería tratar.
• Deje la introducción para el final, cuando esté seguro de todo el material haya sido incluido
en el documento.

Cómo escribir guías de usuario de OOo 6

• No se preocupe si el español (o el inglés si está escribiendo en inglés) no es su primer
idioma. Los revisores pueden ayudarle a refinar el uso de términos especiales, la gramática
y la ortografía (así como otros aspectos). Este consejo es válido aún para los redactores
que escriben en su propio idioma.
• Tenga siempre en mente a un “usuario típico”. Lo que es obvio para usted puede ser algo
totalmente desconocido para alguien que tenga menos experiencia con el producto. Lea la
lista users@es.openoffice.org para tomar conciencia de la clase de problemas que los
usuarios suelen tener.
• Para llegar a ser un mejor escritor, lea mucho (el escuchar audio libros también es de gran
ayuda en su desarrollo). Michael Bremer, autor de Untecnical Writting recomienda leer no
solo libros técnicos, sino también libros científicos populares e incluso guiones y buenos
libros infantiles.

Recursos1
La siguiente lista bibliográfica está basada en algunos libros populares y páginas de Internet
que pueden ser de una gran ayuda o de gran interés tanto para escritores originales como para
editores también.

Resources2
The following are some books and websites that may be useful or interesting for authors and
editors.

English language references

OneLook Dictionary Search, http://www.onelook.com/. Searches multiple online dictionaries for a
word or phrase.
University of Chicago, The Chicago Manual of Style Q & A, http://www.chicagomanualofstyle.org.
Answers to questions on a great many matters of form, from Abbreviations to Word Division.

Technical writing and editing

You don’t have to fill your bookshelf with technical writing books in order to contribute to OOo
user guides. But if you’re interested, here are some resources that may be helpful.
Beer, David F. and David McMurrey. A Guide to Writing as an Engineer. Wiley, 1996. ISBN
0471117153. Targetted at helping “techies” communicate more clearly.
Bremer, Michael. Untechnical Writing: How to Write About Technical Subjects and Products So Anyone
Can Understand. UnTechnical Press, 1999. ISBN 0966994906. A guide to the practical aspects
of writing software documentation.
Perry, Carol Rosenblum, The Fine Art of Technical Writing. Blue Heron Publishing, 1991. ISBN
093608524X. Concise overview of technical writing.

1 N del T. A partir de aquí no he traducido por tratarse de referencias para gente de habla inglesa, poco
útiles para hispanohablantes. En todo caso a las personas que le interesen estas referencias
seguramente no necesitarán traducción.
2 N del T. A partir de aquí no he traducido por tratarse de referencias para gente de habla inglesa, poco
útiles para hispanohablantes. En todo caso a las personas que le interesen estas referencias
seguramente no necesitarán traducción.

Cómo escribir guías de usuario de OOo 7

Weber, Jean Hollis, The Technical Editors’ Eyrie, <http://www.jeanweber.com/>. Resources for
technical editors by ODFAuthors’ chief editor.

Writing in general
Strunk, William Jr. and E.B. White, The Elements of Style, 4th ed. Longman, 2000. ISBN
020530902X. A “classic” that ranges over punctuation, usage, style, and composition in about
100 concise pages. The original edition, without White’s additions, is available online at
http://www.bartleby.com/141/.
Williams, Joseph, Style: The Basics of Clarity and Grace. Longman, 2002. ISBN 0321112520 .
Strunk and White tell you to “omit needless words.” Williams tells you how to figure out which
words are needless. There are two other versions, Style: Ten Lessons in Clarity and Grace, and
Style: Toward Clarity and Grace, which have more detailed discussion of the same principles. Ten
Lessons is a textbook with very helpful exercises, while Toward is aimed at a general audience.

Cómo escribir guías de usuario de OOo 8