Como desarrollador uno puede planificar, diseñar y programar un sistema con relativa fluidez. Tras finalizar el producto del Core del proyecto Kentana me he encontrado en la falta de documentación del mismo. Esto presenta un problema porque queda incompleto sin ella y documentar suele ser una tarea tediosa. No solo para el Core sino para diferentes proyectos en los que he estado le terminamos huyendo a la documentación de proyectos. Esto a veces suele retrasar la entrega de un producto ya que dentro de esta documentación tenemos manual técnico y manual de usuario.
Identificando el problema
El deber ser de la documentación de proyectos es realizarla a medida que se va desarrollando el software. Sin embargo esto en si es un problema porque por lo general ningún proyecto se hace como se planifica. En algunos casos contratan a alguien para documentar especialmente los manuales de usuario, pero no podemos huirle al técnico. La mala planificación y levantamiento de requisitos de los clientes desemboca en múltiples cambios al software. Esto quiere decir que si se hiciera la documentación al principio, habría que cambiarla tantas veces como el software.
Posibles soluciones al problema de documentación de proyectos
Cada empresa y cada desarrollador aportan un estilo que afecta tanto al sistema como a los procedimientos. Tener una política de documentación pienso que no se lograría implementar ya demás retrasaría el desarrollo. Al final de todo, nuestra habilidad comunicativa a veces deja mucho que desear y un manual de usuario se convierte en un desafío para el usuario final. Una posible solución radica en que el sistema sea muy simple e intuitivo, es decir evitar el manual de usuario. En casos de mucha complejidad llevarlo a un listado de operaciones o minimizarlo tanto como sea posible. Aún así tenemos el problema del manual técnico que por más intuitivo que sea siempre debe estar.
Desarrollo de software y descripciones técnicas
Evitarla indica que el software es de muy mala calidad, que el soporte será demorado y que tal vez no se resuelvan solicitudes. En mi caso más reciente he tratado de colocar una categoría «Core Kentana» con algunas especificaciones del sistema. Como el Core está pensado para dar soporte es casi un manual técnico y de usuario a la vez. Por la naturaleza del Core que sería una herramienta para desarrolladores también queda en deuda un «manual de desarrollo». Innovar en este sentido puede ser muy interesante y con la posibilidad de crear herramientas para el Core Kentana se abre una posibilidad de alguna solución. Debería poderse integrar fácilmente y optimizar este proceso, de esta manera sería más productivo el software. Aparte de todo finalizaría más rápido y ayudaría con las pruebas, es decir los beta testers requieren los manuales.
