Documentando Software

Documentación de Sistemas

Algunas buenas prácticas tratan de que la documentación no sea larga ni extendida, pero cuando hace falta es pérdida y cuando existe es ahorro.

Mejor llegar a un término medio ni tan grande ni tan pequeño.

Cuando hablamos de Documentación de Software, estamos hablando de todos los documentos que abarcan la creación y el mantenimiento de un software, no solo de su creación, sino que cada modificación de la misma, deriva también a una modificación en la documentación, llámese nuevas políticas o nuevos procesos, los RFC (Ordenes de Cambios), también exigen una modificación en la parte documental del sistema.

La documentación no solo se basa en la idea o en la necesidad de crear un proceso o comprar un producto para que nos ayude o nos dé una solución a un problema dentro de la empresa.

La Documentación nos da el poder de saber los que hicimos a través del tiempo y estamos dejando una historial para futuros usuarios que manejarían o modificarían dicho software.

Haciendo esto se ganaría tiempo tanto en el desarrollo como en la educación de futuros usuarios ya que tendríamos creados manuales técnicos, manuales de usuario, manuales administrativos de sistema, manuales de contingencia.

Un Ejemplo:

Cuando hay un problema en un proceso ,el programa hizo mal un cálculo y el desarrollador está de vacaciones, que hacemos, como sabemos que hizo , entramos al programa y miramos eso puede llevar horas para saber que exactamente hizo. No sería más fácil leer un manual de procesos en donde en un español entendible nos pueda explicar con facilidad que quería hacer ese proceso , así ganamos tiempo en saber que quería hacer y podemos corregir con más facilidad, eso es un ahorro de costo , energía y recurso que no se tiene en cuenta muchas veces.

Entonces debemos comenzar a ver la existencia de documentación, contratos, inicio de proyectos o proyectos finalizados.

Al saber que si existe documentación podemos tener muchas respuestas a las preguntas de los ejecutivos de la empresa, podemos también proyectarnos a futuro con una mejor línea de base.

Anuncios

Responder

Por favor, inicia sesión con uno de estos métodos para publicar tu comentario:

Logo de WordPress.com

Estás comentando usando tu cuenta de WordPress.com. Cerrar sesión / Cambiar )

Imagen de Twitter

Estás comentando usando tu cuenta de Twitter. Cerrar sesión / Cambiar )

Foto de Facebook

Estás comentando usando tu cuenta de Facebook. Cerrar sesión / Cambiar )

Google+ photo

Estás comentando usando tu cuenta de Google+. Cerrar sesión / Cambiar )

Conectando a %s