Dra. Sara Elena Garza Villarreal
Materia: Programación Orientada a Objetos
Matricula: 1454810
Hora: M1-M3 (Jueves)
La documentación de una empresa representa su capital intelectual, es decir el “saber hacer” que se ha adquirido con la experiencia. Si no se preserva adecuadamente ese conocimiento difícilmente logrado, se podría perder.
Hay varias razones de importancia que tiene la documentación para un sistema de gestión de calidad, entre ellas podemos destacar:
1. La estandarización de los procesos.
Para que un proceso sea debidamente estandarizado, debe estar documentado. Al hacerlo estamos asegurando que las personas ejecuten los procesos de acuerdo a como están escritos.
2. La planificación organizacional.
En cualquier nivel de la organización, al documentar los elementos importantes, como acciones, recursos y tiempos estamos direccionando o enfocando a las personas a cargo, hacia el logro de determinados objetivos y metas. La documentación ayuda a mantener el enfoque y la disciplina hacia los objetivos del sistema.
3. Control de las actividades realizadas.
En este caso hablamos de los registros, que son un tipo especial de documento. Básicamente es la información contenida en formatos diligenciados durante los procesos y que nos va a suministrar evidencia o soporte de la realización de determinadas actividades. Los registros nos permiten conocer y evaluar la gestión realizada.
4. Auditorias.
Las auditorias de los sistemas de gestión de una empresa se basan en los documentos que se tengan. Los documentos representan los criterios de auditoría y los registros representan las evidencias de auditoría. De la comparación de estos dos tipos de documentos se establecen los hallazgos de auditoría, que pueden ser fortalezas o debilidades del sistema.
5. Mejoramiento de procesos.
La documentación, nos permite mejorar los procesos consistentemente. La documentación debe servir a los procesos y no los procesos servir a los documentos. Con esto llamo la atención a no generar documentación que pueda entorpecer los procesos. Un proceso bien diseñado debe tener un buen flujo documental.
6. Capital intelectual.
Los documentos guardan el valor más importante de una empresa, que es su capital intelectual, el saber hacer algo bien hecho y por el cual las personas estan dispuestas a pagar. El no documentar apropiadamente pone en riesgo la capacidad de atender un mercado. Documentar apropiadamente permite a la empresa generar valor del conocimiento adquirido y volverlo ingreso, por eso se le llama capital intelectual.
De acuerdo a todo lo anterior, los documentos deben presentar unas ciertas características para que sean efectivos:
- Ser aprobados por una persona idónea al proceso antes de ser emitidos.
- Estar debidamente identificados y legibles. La identificación se puede hacer mediante una codificación que no induzca a errores.
- Estar disponibles cuando se requieran.
- Deben ser revisados y actualizados periódicamente.
- Las modificaciones que se vayan a realizar deben ser identificadas al igual que el estado de su revisión.
- Estar vigentes para su utilización y así evitar documentos obsoletos en los procesos que puedan inducir a confusiones.
Además para los registros, éstos deben:
- Tener un tiempo de retención (almacenamiento de la información generada).
- Estar accesibles para su consulta.
- Protegidos y seguros, para preservar la información de las condiciones ambientales y de personas no autorizadas.
- Los registros deben tener una disposición final. Una vez se haya cumplido el tiempo de retención qué se va hacer con ellos.
Por último, lo anterior debe estar documentado en procedimientos para su aplicación en el contexto de la Norma ISO 9001.
La documentación de los programas es un aspecto sumamente importante, tanto en el desarrollo de la aplicación como en el mantenimiento de la misma.
La documentación de un programa empieza a la vez que la construcción del mismo y finaliza justo antes de la entrega del programa o aplicación al cliente. Así mismo, la documentación que se entrega al cliente tendrá que coincidir con la versión final de los programas que componen la aplicación.
Tipos de Documentación
La documentación que se entrega al cliente se divide claramente en dos categorías, interna y externa:
Interna: Es aquella que se crea en el mismo código, ya puede ser en forma de comentarios o de archivos de información dentro de la aplicación.
Externa: Es aquella que se escribe en cuadernos o libros, totalmente ajena a la aplicación en sí. Dentro de esta categoría también se encuentra la ayuda electrónica.
Una vez concluido el programa, los documentos que se deben entregar son una guía técnica, una guía de uso y de instalación.
- La guía técnica
En la guía técnica o manual técnico se reflejan el diseño del proyecto, la codificación de la aplicación y las pruebas realizadas para su correcto funcionamiento. Generalmente este documento está diseñado para personas con conocimientos de informática, generalmente programadores.
El principal objetivo es el de facilitar el desarrollo, corrección y futuro mantenimiento de la aplicación de una forma rápida y fácil.
Esta guía está compuesta por tres apartados claramente diferenciados:
Cuaderno de carga: Es donde queda reflejada la solución o diseño de la aplicación.
Esta parte de la guía es únicamente destinada a los programadores. Debe estar realizado de tal forma que permita la división del trabajo
Programa fuente: Es donde se incluye la codificación realizada por los programadores. Este documento puede tener, a su vez, otra documentación para su mejor comprensión y puede ser de gran ayuda para el mantenimiento o desarrollo mejorado de la aplicación. Este documento debe tener una gran claridad en su escritura para su fácil comprensión.
Pruebas: es el documento donde se especifican el tipo de pruebas realizadas a lo largo de todo el proyecto y los resultados obtenidos.
- La guía de uso
Es lo que comúnmente llamamos el manual del usuario. Contiene la información necesaria para que los usuarios utilicen correctamente la aplicación.
Este documento se hace desde la guía técnica pero se suprimen los tecnicismos y se presenta de forma que sea entendible para el usuario que no sea experto en informática.
Un punto a tener en cuenta en su creación es que no debe hacer referencia a ningún apartado de la guía técnica y en el caso de que se haga uso de algún tecnicismo debe ir acompañado de un glosario al final de la misma para su fácil comprensión.
- La guía de instalación
Es la guía que contiene la información necesaria para implementar dicha aplicación.
Dentro de este documento se encuentran las instrucciones para la puesta en marcha del sistema y las normas de utilización del mismo.
Dentro de las normas de utilización se incluyen también las normas de seguridad, tanto las físicas como las referentes al acceso a la información.
Referencias
