Documentos de Académico
Documentos de Profesional
Documentos de Cultura
Instalación de Un Sistema
Instalación de Un Sistema
Proceso de la instalacin
Archivos de datos, por ejemplo datos, imgenes, modelos, documentos XMLDokumente, etc.
Documentacin
Archivos de configuracin
Bibliotecas
Definir las variables de entorno requeridas: Algunos comportamientos del software solo
pueden ser determinados por medio de estas variables. Esto es parte de la configuracin,
aunque es ms dinmica.
La documentacin para desarrolladores es aqulla que se utiliza para el propio desarrollo del
producto y, sobre todo, para su mantenimiento futuro. Se documenta para comunicar
estructura y comportamiento del sistema o de sus partes, para visualizar y controlar la
arquitectura del sistema, para comprender mejor el mismo y para controlar el riesgo, entre
otras cosas.
Obviamente, cuanto ms complejo es el sistema, ms importante es la documentacin.
En este sentido, todas las fases de un desarrollo deben documentarse: requerimientos,
anlisis, diseo, programacin, pruebas, etc... Una herramienta muy til en este sentido es
una notacin estndar de modelado, de modo que mediante ciertos diagramas se puedan
comunicar ideas entre grupos de trabajo.
Hay decenas de notaciones, tanto estructuradas como orientadas a objetos. Un caso
particular es el de UML, que analizamos en otra obra. De todas maneras, los diagramas son
muy tiles, pero siempre y cuando se mantengan actualizados, por lo que ms vale calidad
que cantidad.
La documentacin para desarrolladores a menudo es llamada modelo, pues es una
simplificacin de la realidad para comprender mejor el sistema como un todo.
Otro aspecto a tener en cuenta cuando se documenta o modela, es el del nivel de detalle.
As como cuando construimos planos de un edificio podemos hacer planos generales, de
arquitectura, de instalaciones y dems, tambin al documentar el software debemos cuidar el
nivel de detalle y hacer diagramas diferentes en funcin del usuario de la documentacin,
concentrndonos en un aspecto a la vez.
De toda la documentacin para los desarrolladores, nos interesa especialmente en esta obra
aquella que se utiliza para documentar la programacin, y en particular hemos analizado la
que se usa para documentar desarrollos orientados a objetos en el captulo respectivo.
La documentacin para usuarios es todo aquello que necesita el usuario para la instalacin,
aprendizaje y uso del producto. Puede consistir en guas de instalacin, guas del usuario,
manuales de referencia3 y guas de mensajes.
En el caso de los usuarios que son programadores, verbigracia los clientes de nuestras
clases, esta documentacin se debe acompaar con ejemplos de uso recomendados o de
muestra y una resea de efectos no evidentes de las bibliotecas.
Ms all de todo esto, debemos tener en cuenta que la estadstica demuestra que los usuarios
no leen los manuales a menos que nos les quede otra opcin. Las razones pueden ser varias,
pero un anlisis de la realidad muestra que se recurre a los manuales solamente cuando se
produce un error o se desconoce cmo lograr algo muy puntual, y recin cuando la ayuda en
lnea no satisface las necesidades del usuario. Por lo tanto, si bien es cierto que debemos
realizar manuales, la existencia de un buen manual nunca nos libera de hacer un producto
amigable para el usuario, que incluso contenga ayuda en lnea. Es incluso deseable proveer
un software tutorial que gue al usuario en el uso del sistema, con apoyo multimedia, y que
puede llegar a ser un curso online.
Buena parte de la documentacin para los usuarios puede empezar a generarse desde que
comienza el estudio de requisitos del sistema. Esto est bastante en consonancia con las
ideas de extreme programming y con metodologas basadas en casos de uso.
La documentacin para administradores o soporte tcnico, a veces llamada manual de
operaciones, contiene toda la informacin sobre el sistema terminado que no hace al uso por
un usuario final. Es necesario que tenga una descripcin de los errores posibles del sistema,
as como los procedimientos de recuperacin. Como esto no es algo esttico, pues la
aparicin de nuevos errores, problemas de compatibilidad y dems nunca se puede descartar,
en general el manual de operaciones es un documento que va engrosndose con el tiempo.
Manual de usuario
Los manuales de usuario son guas escritas en formatos impresos (en papel) o en
documentos electrnicos (PDF o XPS) que proporcionan instrucciones de cmo hacer o
utilizar algo. Si bien se considera generalmente a las guas de usuario como manuales
para programas de computacin, las guas de usuario pueden acompaar a
computadoras y a otros dispositivos electrnicos, como televisores, radios estreo,
sistemas telefnicos y reproductores MP3, as como tambin a electrodomsticos y
equipos de jardinera. Los buenos manuales de usuario educan al usuario acerca de las
funciones del producto mientras le ensean a utilizarlas de manera efectiva y estn
dispuestos de tal forma que puedan leerse y consultarse fcilmente. A continuacin, este
artculo presentar algunas cosas para tener en cuenta a la hora de crear un contenido
efectivo y disear la disposicin para un manual de usuario.
Construccin de prototipos