Número 60
21 de xuño de 2023

O truco do manual

Unha vez, cando tiña dezaseis anos, fíxenlle un programa ao meu pai. Resultoume ben complicado de facer pero conseguín domalo, así que estaba bastante orgulloso cando llo amosei. El probouno e no cabo do día díxome: “este programa é complexo de máis; hai que ser informático para entendelo”.

Unha muller facendo caligrafía.

Pásavos iso a vós? Escribides o programa tratando de facelo o máis simple e intuitivo que podedes, pero así con todo a xente di que é complicado de máis. Se vos vedes reflectidos niso, hai un truco que podedes probar: escribide o manual do usuario primeiro e despois facede o programa que se axuste a ese manual.

A orixe deste problema está en que, cando escribides o programa, pensades no código que tedes que escribir e non en como o vai empregar o usuario. Toda a vosa capacidade mental vai ocupada nos bucles, nos ficheiros, nas transaccións e no sistema de compilación, e non vos queda tempo para matinar en se nesta pantalla queda mellor unha morea de botóns ou un menú, se non hai unha maneira de evitar que o usuario teña que facer tantos clics, ou se F4 é, realmente, a mellor tecla que podemos escoller para activar o modo de inserción.

Cando escribides o manual primeiro, as vosas prioridades cambian: xa non estades a tratar de facer que o programa funcione, senón que o voso obxectivo é explicalo ben. Un programa difícil de usar tamén é difícil de explicar, así que os cambios que fagades nel mentres tratades de escribir o manual van simplificalo. No final, como por arte de maxia, o voso manual vai describir un programa sinxelo, doado de entender, e case sempre doado de usar.

Polo tanto, escribide o manual primeiro, revisádeo unhas poucas veces para asegurarvos de que cubre todas as necesidades e que é coherente, e despois escribide o programa seguindo as prescricións do voso manual da maneira máis exacta que poidades.

É posible que algunhas das cousas que escribistes no manual non sexan posibles tecnicamente e teñades que facer cambios, pero non caiades na tentación de facer cambios para simplificar o código, que ese é o problema que tiñades no principio e queriades evitar.

Este truco trae aínda máis beneficios que un programa doado de usar. O máis evidente é que ides acabar tendo un manual para o voso programa. Outro é que ese manual é, ao mesmo tempo, un documento de requirimentos e un documento de deseño. A moita xente resúltalle máis doado entender un manual de usuario que un documento de requirimentos, así que o cliente vai poder facer máis e mellores observacións e correccións.

A próxima vez que vaiades facer un programa, escribide o seu manual primeiro e dicídeme que tal vos foi.

A ilustración desta Folla procede dun gravado de 窪俊満 (Kubo Shunman).