El difícil arte de escribir

Hace unos meses, un lector me envió, a través del formulario de contacto del sitio, una pregunta muy interesante. En el artículo de hoy quiero explorar en mayor profundidad la breve respuesta que le di en su momento, convirtiéndola en un «ensayo» independiente. Aquí va.


En mis vueltas por la red, muchas veces me he cruzado con variaciones de la siguiente ridiculez frase: «una de las formas más simples de ayudar a un proyecto de software libre es escribir documentación sobre el mismo».

No.

Escribir documentación es una de las formas más útiles de ayudar a un proyecto de software libre, ¡pero de simple, nada!

Escribir bien es difícil, mucho (¡mucho!) más de lo que la gente cree. Requiere conocer a la perfección el software del que se habla y a sus usuarios, requiere muchísimo trabajo de planificación, buscar formas alternativas de explicar, de usar… y por sobre todas las cosas requiere dedicar horas y horas de trabajo para construir, pulir y corregir. Y luego volver a pulir y volver a corregir.

Escribir documentación útil también requiere conocer el idioma en el que se escribe, algo que, desgraciadamente, muchos escritores de la red suelen pasar por alto. Una prosa inconsistente o monótona, abusar de los signos de puntuación o el prodigarse en palabras técnicas (pecados en los que yo también he caído) no ayuda a que te comprendan.

Escribir bien es un gran desafío y un esfuerzo enorme que además requiere práctica y atención al detalle, pero el poder ayudar a los demás, incluso a través de la palabra, siempre vale a pena.

Atención, que este artículo no es para descorazonar a los potenciales escritores, sino todo lo contrario: escribir bien es un desafío, sí, pero uno sumamente gratificante y realmente útil que puede ayudar a muchísimas personas. Si te gusta escribir, ¡escribe! Lo único que te pido es que lo hagas dándole la importancia, y el tiempo, que la tarea merece.

No sé qué valor tengan, pero aquí van los pocos consejos que puedo darte.

Para empezar, una variante del viejo cliché: si escribes «a prueba de tontos» solo los tontos te leerán, pero si escribes «solo para expertos» ni siquiera los expertos te leerán. Dale a tus lectores la posibilidad de esforzarse un poco ya que solo con esfuerzo se aprende, pero no exageres.

Nunca escribas por obligación. Si bien es útil fijarse una rutina de publicación, intentar una rutina de escritura es contraproducente: si un día no tienes deseos de escribir, no escribas, que no pasa nada. Aún en esos momentos en los que solo quieres distraerte con vídeos o juegos, en el fondo de tu mente el proceso seguirá adelante y cuando vuelvas a sentarte frente al teclado verás que la pausa fue útil.

Toma la tarea como un juego personal, como un desafío, que así nunca te resultará pesada.

Pon tu afecto no solo en aquello sobre lo que estás escribiendo, sino también en cómo lo estás escribiendo.

Si puedes decir lo mismo con menos palabras o con palabras más simples, ya estás tardando en editar tu texto.

De ser posible, que otras personas lean lo que escribes antes de publicarlo: puede ser que tu familia te odie por eso, pero tus lectores te lo agradecerán.

Si no encuentras a otro friki que pueda funcionar de beta tester, antes de la revisión final deja «descansar» el texto por unos días: dedícate a otro proyecto, pon por un tiempo tu mente en otra cosa, que así al volver todo resultará más claro y te será más sencillo el encontrar errores sutiles.

También es útil, si bien no siempre se puede hacer, el tratar de «ver todo con otros ojos». Por ejemplo, traducir mi libro sobre Writer al inglés me ayudó a encontrar, y a corregir, pequeños problemas de consistencia en el texto.

En fin, diviértete escribiendo, que esa es la única forma de hacerlo bien.

Y mantén siempre a mano los diccionarios de la RAE, tanto el de la lengua española como el diccionario panhispánico de dudas: yo los uso todo el tiempo. Ya hablamos por aquí sobre cómo utilizarlos en el escritorio Plasma. También te recomiendo el trabajo del profesor Alberto Bustos, tanto en su blog como en su canal de youtube, que lo que ofrece es oro puro para quienes deben escribir en castellano.

Es más, de dejo con un par de sus vídeos:

Resumiendo: ¿quieres ayudar a tu proyecto de software libre favorito, pero no sabes programar? ¡Escribe! Pero no porque sea fácil, que no lo es, sino porque vale la pena el hacerlo.

Anuncios

Disponible LyX 2.3.2

Una rápida entrada para este viernes de diciembre: si bien los usuarios de openSUSE ya lo tenemos desde hace unos días en el repositorio publishing, hoy el proyecto LYX ha anunciado la disponibilidad de una nueva versión de corrección de errores de la línea 2.3

Public release of LyX version 2.3.2

La lista de correcciones de error y mejoras en la interfaz gráfica es grande, por lo que te dejo explorar el anuncio. Happy LYXing!

Munson, una agradable «slab serif»

Este artículo es parte de la serie Recomendando fuentes tipográficas


Debo admitirlo, nunca me he sentido particularmente atraído por las fuentes «slab serif», pero la que hoy presento no solo es casi una serif «normal»: está tan bien diseñada, con terminaciones «en esfera» en algunos puntos particularmente bien elegidos, que estoy seguro que aquellos que gusten de la tipografía del siglo XIX la encontrarán sumamente interesante:

Munson, por PJMiller

La lista de habilidades OpenType es más bien reducida, pero seguramente podrá encontrar un lugar en textos no muy «exigentes».

Writer: «encerrar» un texto con líneas

Hoy tendremos una entrada rápida y sencilla, que estamos en diciembre: solo un pequeño truco para «enmarcar» un texto.

¿Cómo logramos estos efectos en Writer?

Para realizar esto necesitamos un párrafo que tenga definido dos tabuladores, uno al centro del área de texto con alineación centrada y el otro a la derecha del área de texto con alineación a la derecha. Un estilo de párrafo que tiene tales tabuladores definidos por defecto es el estilo Cabecera.

Pues bien, supongamos que en un párrafo con estos dos tabuladores perfectamente definidos insertamos un tabulador, el texto y un último tabulador. Ahora seleccionamos, uno a la vez, los tabuladores y vamos a Formato → Carácter → pestaña Efectos tipográficos: allí seleccionamos el estilo de Tachado que nos interese.

Las dos últimas líneas de texto, aquellas «enmarcadas», tienen un truco adicional: ya sea como formato directo (mejor no) o desde el estilo de párrafo, vamos a la pestaña Bordes y… creo que ya se entendió 🙂

Mostrando datos «en línea» con la fuente Sparks

Este artículo es parte de la serie Recomendando fuentes tipográficas


El proyecto que presento hoy es más una curiosidad que otra cosa, pero no por eso menos interesante.

La idea es presentar datos en forma de pequeños gráficos de barras o de línea, pero hacerlo «en línea» y sin utilizar otro software, solo un programa que soporte OpenType y la tabla de sustitución +calt (Contextual Alternates). ¿Cómo?, pues simplemente utilizando una de las quince fuentes tipográficas de este proyecto

Sparks | A typeface for creating sparklines in text without code

en un programa como LibreOffice Writer o XƎTEX. ¿El resultado?

Los números fuera de las llaves serán ignorados mientras que los otros, separados por comas, serán convertidos en «datos». Tenemos a disposición 101 «niveles» (del 0 al 100, inclusos) y tres «estilos», cada uno en cinco «pesos».

Es posible entrar texto normal, pero no resulta tan interesante: su uso principal (digamos, su único uso) es para presentar datos.

La fuente también puede ser descargada desde la página GitHub del proyecto.

Curioso proyecto, ¿verdad?

LyX: explorando las «LFUN»

LYX es tan increíblemente completo que al escribir mi libro sobre el programa dejé necesariamente muchísimas cosas afuera. Hoy hablaré brevemente de una de ellas: las «funciones LYX», o LFUN.

Algo que sí cuento en el libro es cómo crear un atajo de teclado. Pues bien, allí indico que debemos asociar una «instrucción» al atajo que queremos crear, por ejemplo

specialchar-insert lyx

para insertar el logo del programa: LYX. Pues bien, esa línea de comando es una de las tantas (¡tantas!) «LFUN» disponibles.

Ciertamente estas funciones pueden utilizarse para mucho más que crear atajos de teclado: de hecho es posible controlar completamente el programa a través de ellas… o utilizarlas directamente gracias al mini-buffer.

Como ejemplo daré otra instrucción relacionada con dos artículos anteriores (1 y 2): insertar caracteres unicode arbitrarios.

Para abrir el mini-buffer es suficiente presionar Alt-X: con esto se abre una línea de comando donde podemos utilizar nuestra instrucción. Por ejemplo, para insertar el carácter № (U+2116) presionamos Alt-X, escribimos

unicode-insert 2116

es decir, la LFUN para insertar caracteres unicode seguida del código exadecimal del carácter, luego presionamos intro y ya estamos

La lista completa (¡y extensa!) de funciones está en el manual que se encuentra en Ayuda → Funciones LyX. Algunas son más útiles que otras y a muchas se puede acceder de otras formas más confortables, pero para los amantes de la línea de código, pues que allí tienen con qué entretenerse.

Algunas novedades de LibO 6.2

NOTA (que será eliminada cuando ya no sirva): desde hace unos días, y por algunos días más, estoy completamente «off-line». Este artículo fue programado para hoy hace un par de semanas (solo este párrafo es «reciente»), por lo que tendría que publicarse solo. Es decir, si lees este artículo, dejas un comentario y ves que tardo en responder, no te preocupes, que ya vuelvo. Ya volví…


El desarrollo de LibO es un «blanco móvil», por lo que si bien en el libro comento un par de novedades que aparecerán en LibO 6.2 a principios del 2019 (como el «asistente» para utilizar propiedades OpenType y Graphite), otras han sido implementadas desde entonces, por lo que hoy quiero hablar de algunas que han llamado mi atención.

La más importante, al menos en mi opinión, la posibilidad de deshabilitar los menús de las cabeceras / pie de página

Esos menús que aparecen cuando hacemos clic sobre el área de las cabeceras o pie de página pueden resultar muy molestos, especialmente si consideramos lo simple que resulta hacer clic allí por accidente. Y vamos, ¿cuántas veces por documento necesitas editar las cabeceras de página? ¿Vale la pena tener un menú siempre activo por allí? Pues bien, a partir de 6.2 ya podemos desactivarlo, ¡sí!

Otra cosa interesante son más opciones para modificar la altura de las filas en una tabla

En otras noticias generales, las interfaces para gtk2 y KDE4 han sido marcadas como en «desuso» (deprecated) y serán eliminadas en una próxima versión, mientras que la interfaz para Qt5  está mejorando para regalarnos una mejor integración con escritorios Plasma y LXQt.

Este nuevo plug-in para VCL parece funcionar bastante bien, pero tiene algunas limitaciones.

En fin, nada terriblemente innovador, pero en general una buena actualización.