Tienes una idea genial para un sitio web, aplicación móvil o software, y eliges al desarrollar web capaz de hacer realidad ese producto. Es un momento emocionante y una gran ventura hasta que algo va mal, ¡y te das cuenta que estás en un callejón sin salida!
Desgraciadamente vemos esto con demasiada frecuencia: con clientes al borde de la desesperación, un negocio descarrilado y sin nadie que pueda ayudarlos o, llegados a este punto, nadie que quiera involucrarse.
Entonces, ¿qué no funciona y cómo el cliente debería evitarlo?
Todos los sitios webs y aplicaciones están basadas en código. Hay una buena razón por la que se llama «código». El código, por definición, es un lenguaje secreto, que permite que solo aquellos que lo conocen lo entiendan.
Por lo que, si no cuentas con documentos que detallen el código, te enfrentas a serios problemas, ya que ni tú ni nadie puede descifrar el código.
¿Qué documentos necesitas?
Los desarrolladores webs o cualquier otro desarrollador de software deben llevar un registro de su trabajo y estos son los documentos que necesitas.
1. Documenta tu pedido
El mejor consejo para quienes trabajan con un desarrollador es asegurarse de que documentan lo que necesitan que el software o la página web haga. Es absolutamente necesario.
Sabemos que es aburrido, ¡pero ser un rehén después tampoco es muy divertido!
Siéntate con tu equipo y define:
- ¿Cuál es el objetivo?
- ¿Qué funcionalidades DEBE tener tu proyecto?
- ¿Qué funcionalidades te gustaría tener?
- ¿Cuáles son los hipotéticos escenarios?
- ¿Qué quieres que pase en cada caso?
Con suerte llegas a hacerte una idea, pero debes documentar esto. Esto no solo ayuda al desarrollador a entender tus necesidades y expectativas, sino también te ayuda a evitar cualquier malentendido o conflicto.
Aquí hay algunas pautas sobre lo que tu documento debería incluir.
2. Manual de usuario
Cuando el desarrollo esté terminado, insiste en que se prepare un manual de usuario. Este documento debe tener instrucciones claras sobre “Cómo hacer las cosas” y, de ser necesario, capturas de pantalla, tablas de flujo, etc.
Esto te permitirá entrenar a tu personal en el futuro, pero también te da un punto de referencia en caso de que en algún momento necesites añadir funcionalidades o solicitar la corrección de errores. Recuerda que la definición misma de un error es «cuando el software no se comporta como se describe en el manual». Si no hay manual, nunca puede haber un error, lo que explica por qué algunos desarrolladores son reacios a proporcionar un documento de este tipo.
3. Documentación del código
Esto solo se puede realizar al final del proyecto, y debe ser un complemento del manual de usuario, que describe “Cómo están hechas las cosas” en el software.
Por ejemplo, debe describir qué llamadas PHP se hacen o scripts se ejecutan cuando se pulsa un botón específico, o qué scripts/php se utilizan para entregar los resultados y hacer que funcione, en definitiva… ¡la funcionalidad!!!
Este es un documento clave porque le permite a tus desarrolladores identificar los problemas o añadir funcionalidades complementarias. Además, esto le permite a otros desarrolladores ayudarte en caso de tener que recurrir a otra persona para que te asista (otra razón por la que los desarrolladores no son muy proclives a entregar esta información).
¿Por qué algunos desarrolladores no hacen esto?
Hay dos razones fundamentales por la que esta forma de trabajo no le gusta a algunos desarrolladores.
Primero, la mayoría de los ingenieros son reacios a hacer esto, ya que es un trabajo aburrido y tedioso, pero también es un proceso que consume mucho tiempo y, por lo tanto, es caro.
Segundo, el no proveer esta documentación ata al cliente al desarrollador original, lo que significa que cualquier futuro problema o mejora del producto solo puede resolverse con el desarrollador original. Si un tercero intenta hacer cualquier trabajo tiene que volver sobre los pasos del código para decodificar lo que está sucediendo. Recuerda que es código y, si no lo decodificas, no puedes respaldarlo. La ingeniería inversa de un producto con documentación es bastante difícil, pero hacerlo sin ella consume tiempo, es complejo, y no siempre da buenos resultados, por lo que se vuelve costoso.
Resumen
La documentación para tu software a medida, sitio web o funcionalidad adicional es fundamental. Si evitas este proceso seguramente te tomarán como rehén. ¡La mayoría de los desarrolladores experimentados no tocarán un software indocumentado ya que no tienen idea de cuál podría ser el resultado!
Pide la documentación como parte de tu proceso de licitación y asegúrate de que recibes la documentación necesaria antes de abonar el trabajo
Si tu potencial desarrollador no te ofrece este servicio o se niega a involucrarse, te recomendamos que te retires y busques a otra persona o Contacta con nosotros. Si no lo haces, te va a salir más caro después.