La correcta documentación de cada programa es un punto realmente significativo, ya sea para el desarrollo de cualquier aplicación como su mantenimiento. Muchas personas no hacen esta parte del desarrollo y no se da cuenta de que pierde toda posibilidad al momento de reutilizar el programa para aplicarla en otras aplicaciones, sin tener que saberse el código de memoria.
La buena documentación del programa comienza al mismo tiempo que se crea el mismo y termina justo antes de poder entregar la aplicación o programa al cliente. De la misma forma, la documentación se le da al cliente y tiene que concordar con la versión final de cada programa compuesta por la aplicación. Cuando ya haya terminado, todo documento se tiene que dar con una guía técnica, una del manejo y otra de instalación.
Los tipos de documentación
La documentación la cual debe darse al cliente se separa de forma obvia en dos categorías, la interna y la externa:
- Interna: Es esa que se elabora en el mismo código, ya sea en forma de comentario o archivo de información dentro de la aplicación.
- Externa: Es la que se escribe en los cuadernos o libros, completamente ajena a la aplicación. En esta categoría asimismo se haya la ayuda electrónica.
El manual técnico
Con respecto al manual técnico, decimos que refleja todo el diseño del trabajo, la correcta codificación de la aplicación y toda prueba hechas con el fin de tener una buena función. Usualmente ese documento está creado para las personas con conocimientos en la informática, usualmente son programadores.
La principal misión es suministrar toda sencillez en el desarrollo, la corrección y el futuro mantenimiento de la aplicación de una manera más rápida y sencilla.
Se trata de una guía la cual está comprendida por tres aparatos que claramente pueden distinguirse:
- El cuaderno de carga: Aquí es donde está reflejada toda respuesta o diseño de la aplicación.
- Programa fuente: En ella se agrega la codificación hecha por cada programador. Es un documento donde se debe tener, al mismo tiempo, otro tipo de documentación para un mejor entendimiento y logra ser de beneficio para el mantenimiento o progreso de la aplicación.
- Las pruebas: Se trata del documento en el que se determinan los tipos de pruebas hechas a lo largo del proyecto y cada resultado conseguido.
El manual de manejo
Convencionalmente se le llama manual del usuario. Posee todos los datos que se requieren para que las personas puedan usar de forma correcta la aplicación.
Es un documento el cual trabaja como guía técnica pero que logra suprimir cualquier tecnicismo y muestra de manera más comprensible para todas las personas que no sean profesionales en la rama de la informática. Un factor a considerar es que su elaboración no debe hacer referencia a algún apartado de la guía técnica y en caso de que se maneje un tipo de tecnicismo tiene que ir escoltado por un glosario al final de la misma para un mayor entendimiento. El manual de instalación
Esta tiene todos los datos requeridos para poder implementar dicha aplicación. Dentro del documento se halla cada instrucción para poner en marcha el sistema y cada norma del manejo.
Dentro de esas normas se anexan asimismo, cada norma de seguridad, física y las vinculadas al acceso de información.
