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.