SERVICIO NACIONAL DE APRENDIZAJE SENA Centro Agropecuario Regional Cauca Programa de Formacin : Anlisis y Desarrollo de Sistemas de informacin

Modelo de Mejora Continua

Fecha: Julio de 2010 Versin 1.0 Pgina 1 de 9

GUA DE APRENDIZAJE Manual Tcnico de mi desarrollo software

1. IDENTIFICACION DE LA GUIA DE APRENDIZAJE Fecha: 04 / 04 / 2011 Cdigo: 228106-13774-1006 01 Nombre del Proyecto: SISTEMA DE (Duracin en horas) 28 INFORMACIN INTEGRAL PARA LA GRANJA DEL CENTRO AGROPECUARIO REGIONAL CAUCA Fase del Proyecto: Desarrollo del sistema de informacin Modalidad de formacin: Desescolarizada Equipo Ejecutor: Diego Bolaos, Lorena Cern, Fabin A. Muoz A. NORMA DE COMPETENCIA CDIGO DENOMINACIN Desarrollar el sistema de informacin que cumpla con los requerimientos de la 220501007 solucin informtica RESULTADO DE APRENDIZAJE CDIGO DENOMINACIN Elaborar el manual tcnico de la aplicacin, de acuerdo con la complejidad del 220501007 06 aplicativo y segn normas y procedimientos establecidos por la empresa 2. JUSTIFICACIN La crisis del software se presento en aos anteriores por que en este tiempo los desarrolladores solo tienen presente el diseo y codificacin de las sentencias software en un lenguaje de programacin, dejando vacios en cuanto al uso y entendimiento del proceso de desarrollo a terceros, y peor an cuanto dentro del mismo grupo de desarrollo haban modificaciones de personal y estos nuevos integrantes deban comprender lo que otros disearon, a lo que llevo que muchas veces se efectuaran procesos de reingeniera innecesarios ocasionando sobre costos que a fin de cuentas se traduca en un sobre costo para el cliente. As es como naci la ingeniera del software, disciplina que contextualiza como importante labor la documentacin tcnica de todos los procesos de desarrollo de software, en el cual, recoge aspectos de identificacin de requerimientos, anlisis de necesidades, diseo del sistema de informacin, desarrollo y codificacin y elaboracin de pruebas. Con esto, la calidad de los productos fue mejorando pero an queda mucho camino por recorrer. Esta gua de aprendizaje recoge los elementos conceptuales y prcticos necesarios para que el aprendiz desde un aprendizaje individual y colectivo, desarrolle las habilidades para documentar los procesos tcnicos y transmitirlos a terceros a partir del manual tcnico del sistema de informacin. Desarrolle cada una de las actividades propuestas en los tiempos establecidos para que el proceso formativo alcance los objetivos presupuestados, adems contar con el apoyo de la

SERVICIO NACIONAL DE APRENDIZAJE SENA Centro Agropecuario Regional Cauca Programa de Formacin : Anlisis y Desarrollo de Sistemas de informacin
Modelo de Mejora Continua

Fecha: Julio de 2010 Versin 1.0 Pgina 2 de 9

GUA DE APRENDIZAJE Manual Tcnico de mi desarrollo software

plataforma senastage para obtener material de apoyo, evidenciar los productos desarrollados y contar con la asesora del instructor.

3. ACTIVIDADES Y ESTRATEGIAS DE APRENDIZAJE ACTIVIDAD DE APRENDIZAJE 2: Didcticas y redaccin de textos

La redaccin de todo manual as sea tcnico o de otro tipo, requiere de una escritura clara y concisa, por lo que se debe identificar el equilibrio entre los conceptos tcnicos y una jerga profesional. As mismo, la didctica que busca la eficiencia en transmitir conocimientos, es un recurso indispensable al momento de desarrollar un documento tcnico. Por otra parte, todo redactor u orador, debe identificar la poblacin a la que se dirigir ya sea tanto en forma escrita como oral, por lo que conocer la poblacin lectora en este caso, es sumamente importante. Actividad Integradora: Lea y analice de manera activa el documento Elaboracin de Manuales Didcticos y desarrolle los siguientes tems: y Categorice a la poblacin objetivo quien ser la lectora del manual tcnico (identifique caractersticas como estudios u rea de trabajo, nivel de uso de herramientas TICs, carcter o personalidad en general) Categorizar el rea de implementacin del sistema de informacin. Elabore una ficha en la que describa la caracterizacin de esta poblacin y del rea de implementacin del sistema de informacin Prepare con respecto al manual tcnico y Introduccin y Justificacin y Objetivos del documento y Glosario de trminos (para el rea tcnica y trminos relacionados con el software) y Defina el logo, eslogan de su producto software y Descripcin general del sistema: este punto esta compuesto por los tems que se

y y

SERVICIO NACIONAL DE APRENDIZAJE SENA Centro Agropecuario Regional Cauca Programa de Formacin : Anlisis y Desarrollo de Sistemas de informacin
Modelo de Mejora Continua

Fecha: Julio de 2010 Versin 1.0 Pgina 3 de 9

GUA DE APRENDIZAJE Manual Tcnico de mi desarrollo software

describen a continuacin
o o

o o

Identificacin del sistema: Nombre y siglas que lo identifican. Objetivos: Descripcin breve del objetivo general del nuevo sistema, incluyendo referencia a las funciones del negocio (planificacin, gestin, etc) qu cubre y cmo lo hace. Alcance: Diagrama de contexto1 que muestre la interaccin del sistema con el resto de los sistemas de la organizacin. Caractersticas generales. Descripcin breve de las siguientes especificaciones funcionales y/o tcnicas:  Enfoque de desarrollo (a medida, paquete de software, etc).  Herramientas de desarrollo.  Tipo de procesos (misional, estratgico o apoyo) con su descripcin. Polticas relacionadas con su uso. Siguiendo las polticas, normas y estndares vigentes, se debern adjuntar:  Identificacin del responsable de los datos.  Identificacin de informacin confidencial y pblica para su tratamiento.  Principales sectores usuarios.  Perfiles de usuarios y esquema general de seguridad.  Plan de contingencia que explique los mtodos de trabajo alternativos ante fallas.  Plan de recuperacin que explique los procesos de recuperacin y reinicio ante los casos eventuales de destruccin o desastre. Principales funciones: Narrativa breve que describa las principales funciones del sistema. Se podr acompaar de un esquema donde se identifiquen las actividades del negocio cubiertas por el sistema y sus necesidades de informacin. Observaciones: Cualquier informacin que no haya sido especificada antes y que se considere de inters.

Tiempo estimado para la actividad 4 horas (Da 1) Fuentes de conocimiento: Trabajo colaborativo, TICs, Instructor (a travs de cualquier medio concertado) Ambiente(s) requerido: Ambiente TICs dotado de Equipo s de cmputo y paquete funcional de ofimtica. Material (es) requerido: Instructor (es): Lorena Cern.

11

Diagrama de contexto, mayor informacin http://sisab.lce.org/~yavier/Analisis.html

SERVICIO NACIONAL DE APRENDIZAJE SENA Centro Agropecuario Regional Cauca Programa de Formacin : Anlisis y Desarrollo de Sistemas de informacin
Modelo de Mejora Continua

Fecha: Julio de 2010 Versin 1.0 Pgina 4 de 9

GUA DE APRENDIZAJE Manual Tcnico de mi desarrollo software

ACTIVIDAD DE APRENDIZAJE 2: Elaboracin del manual

El documento referente al manual tcnico recoge las caractersticas analizadas y diseadas para el desarrollo del sistema de informacin que se describe en el manual tcnico y adems, las necesidades que el sistema requiere para funcionar tanto de manera normal como de manera ptima. El manual pretende satisfacer una de los puntos neurlgicos en la etapa de funcionamiento del producto software su mantenimiento, ya que los problemas con los que se enfrentan las personas que desarrollan esta actividad surgen de la misma documentacin que se genera con el desarrollo puesto que y y y y y Nunca existi o se ha perdido! Es incompleta o escasa. No est actualizada con los cambios que se han ido haciendo al sistema. Tiene contradicciones con el contenido real del cdigo. No es clara.

Por lo tanto el objetivo se centra en documentar en forma detallada las caractersticas de cada componente de la arquitectura tcnica del sistema y servir como base para el mantenimiento futuro de los procesos y programas del sistema.

La primera etapa de la elaboracin del manual tcnico se debe enfocar en estructurar la PRELIMINARES DEL MANUAL Identificacin del documento: Este documento debe incorporar la siguiente informacin: y y Logotipo de la organizacin (del proyecto formativo) Nombre empresa desarrolladora (Del CEAPS o Proyecto formativo).

SERVICIO NACIONAL DE APRENDIZAJE SENA Centro Agropecuario Regional Cauca Programa de Formacin : Anlisis y Desarrollo de Sistemas de informacin
Modelo de Mejora Continua

Fecha: Julio de 2010 Versin 1.0 Pgina 5 de 9

GUA DE APRENDIZAJE Manual Tcnico de mi desarrollo software

y y y y

Denominacin: Nombre completo del documento Lugar y fecha de elaboracin. Versin. Responsables de: Elaboracin, Revisin y Aprobacin del Documento (En este caso La elaboracin ser responsable todo el CEAPS determinando un Lder, la revisin a cargo del instructor y la aprobacin del experto) la revisin y aprobacin se debe hacer mediante acta.

y y

Cdigo del documento (esta denominacin deber indicar la etapa donde se encuentra la elaboracin del manual y ser construida y explicada por el CEAPs) ndice: Tabla de contenido, ndice de grficas, ndice de tablas.

1. Contenido tcnico 1.1. Definicin de requerimientos implementadas en el sistema desarrollado 1.2. Diagramas de flujo de datos (Diagrama de casos de uso y de secuencia de cada caso de uso) 1.3. Diccionario de datos. 1.4. Histrico de pruebas efectuadas mencionando errores detectados y acciones correctivas 1.5. Descripcin de campos requeridos por Interfaz (Se deben presentar las interfaces). 1.6. Requerimientos de interfaz con otros sistemas (en caso de conectarse con otra aplicacin) 1.7. Diseo lgico de datos, diagrama entidad-relacin MER y Diagrama de Clases. 1.8. Diseo fsico de base de datos: Contiene las definiciones detalladas de todos los archivos y/o bases de datos del sistema y cada uno de sus componentes (tablas, columnas, claves, ndices, integridad referencial, triggers, etc). Adjuntar la forma en que cada programa los accede y procesa sus datos, su localizacin fsica y la descripcin de su sistema de backup. Para aquellos que tengan proceso de mantenimiento independiente del sistema, se deber adjuntar la forma de acceso al men correspondiente y las instrucciones para su uso. Se complementa con el diagrama de distribucin2 1.9. Plataforma de usuario. Se debe especificar que caractersticas deben tener los puestos de trabajo en cuanto a: 1.9.1. Paquetes de servicio de servidores de datos (ftp) 1.9.2. Plug in requeridos para que funcione correctamente las aplicaciones (p.ej. Java Maquina virtual, SDK De usar algn dispositivo externo, Abode Acrobat Reader Si su sistema genera reportes en PDF, Flash Para animaciones que estn en sus
2

Mayor informacin consulte http://jaimemontoya.com/informaticsprojects/diagramasuml.php

SERVICIO NACIONAL DE APRENDIZAJE SENA Centro Agropecuario Regional Cauca Programa de Formacin : Anlisis y Desarrollo de Sistemas de informacin
Modelo de Mejora Continua

Fecha: Julio de 2010 Versin 1.0 Pgina 6 de 9

GUA DE APRENDIZAJE Manual Tcnico de mi desarrollo software

desarrollos, entre otros) 1.9.3. Requerimientos de hardware para que el sistema de informacin funciones de manera ptima (p ej. Velocidad de procesador, capacidad de disco duro, memoria RAM, entre otros) 1.10. reas de aplicacin y/o alcance de los procedimientos. Describe que acciones desarrollan cada una de las opciones del sistema de informacin con respecto al rea a la que se atiende la necesidad tecnolgica. Especificaciones de los mdulos. Por cada mdulo deber tenerse la siguiente informacin: Nombre del mdulo. Descripcin detallada del mdulo y sus funciones. Diagrama general del mdulo. Flujo de pantallas (si corresponde) Lista de componentes que lo implementan. Lista de bases de datos. Lista de archivos y tablas que utiliza. Lista de las vistas lgicas de los datos. 2. Responsables de la elaboracin: Con el propsito de homogenizar la labor de la documentacin del manual, se debe establecer responsabilidades al interior del equipo de trabajo, iniciando con la seleccin de un lder quien deber coordinar todo el proceso, este lder deber documentar las responsabilidades asumidas por cada uno de los integrantes y verificar si se cumpli con el objetivo. . ACTIVIDAD 1: Siga las instrucciones que se describen a continuacin y y y Seleccione el lder del proceso de elaboracin del manual (Esta persona deber efectuar un informe ejecutivo del desarrollo de las actividades desarrolladas) Elaboren los preliminares del manual y los puntos 1 y 2 de la estructura del documento Recopilen la informacin generada en el transcurso del desarrollo del modulo del proyecto asignado.

Tiempo estimado para la ACTIVIDAD GENERAL : 24 horas, este tiempo se distribuye de acuerdo con las siguientes actividades planteadas:

SERVICIO NACIONAL DE APRENDIZAJE SENA Centro Agropecuario Regional Cauca Programa de Formacin : Anlisis y Desarrollo de Sistemas de informacin
Modelo de Mejora Continua

Fecha: Julio de 2010 Versin 1.0 Pgina 7 de 9

GUA DE APRENDIZAJE Manual Tcnico de mi desarrollo software

ACTIVIDAD 2: Desarrollen los puntos del contenido tcnico del 1.1. al 1.6 Tiempo estimado para la ACTIVIDAD 2: 4 horas (Da 2, 3)

ACTIVIDAD 3: Desarrollen los puntos 1.8 al 1.9 Tiempo estimado para la ACTIVIDAD 2: 4 horas (Da 4)

ACTIVIDAD 4: Desarrolle el tem 1.10 de la gua. Tiempo estimado para la ACTIVIDAD: 4 horas (Da 5)

ACTIVIDAD 5: Revisin del documento. y ajustes respectivos Tiempo estimado para la ACTIVIDAD: horas (Da 6 y 7)

NOTA: La distribucin de estas actividades se hace con el propsito de buscar una eficiencia dentro del proceso de formacin mediante la modalidad desescolarizada, usted puede gestionar su tiempo teniendo presente entregar la evidencia en la fecha establecida en esta gua. Ambiente(s) requerido: Ambiente TICs dotado de Equipo s de cmputo y paquete funcional de ofimtica. Material (es) requerido: Material para documentar el manual tcnico Instructor (es): Lorena Cern. 4. REFERENTES DE CONSULTA PARA ACTIVIDADES y y Elaboracin de un manual tcnico Autor: Instituto tcnico de capacitacin y productividad Cmo escribir un documento tcnico Autor: Enrique Alba Departamento de lenguaje y Ciencias de la Computacin de la Universidad de Mlaga - Espaa Diagramas UML http://jaimemontoya.com/informaticsprojects/diagramasuml.php Diagrama de contexto, mayor informacin http://sisab.lce.org/~yavier/Analisis.html Material para documentar el manual tcnico Autora: Lorena Cern

y y y

SERVICIO NACIONAL DE APRENDIZAJE SENA Centro Agropecuario Regional Cauca Programa de Formacin : Anlisis y Desarrollo de Sistemas de informacin
Modelo de Mejora Continua

Fecha: Julio de 2010 Versin 1.0 Pgina 8 de 9

GUA DE APRENDIZAJE Manual Tcnico de mi desarrollo software

5. EVALUACION Y EVIDENCIAS EVIDENCIA 1: Manual tcnico Criterios de - El manual tcnico de la aplicacin, documentando los procesos Evaluacin: involucrados en la administracin especializada del sistema de informacin, segn normas y procedimientos de la organizacin - Utiliza con criterio tcnico las tecnologas de la informacin y la comunicacin de acuerdo con las actividades a desarrollar. - Presenta las evidencias de manera oportuna y de acuerdo con lo concertado. - Resuelve conflictos mediante el uso de la racionalidad, la argumentacin y la asertividad Instrumentos de Lista de chequeo Evaluacin: Desempeo Conocimiento Producto X Tipo de Evidencia: Entregue el manual tcnico del sistema de informacin con cada uno de los Descripcin de la tems presentados en la gua de aprendizaje Actividad de Aprendizaje 2 evidencia: Presente mediante acta las firmas de los encargados de la revisin y aprobacin del mismo (Para este punto no aplica la fecha de entrega) Forma de entrega: A travs de la opcin Actividades de la plataforma de Senastage en la carpeta con el nombre del resultado de aprendizaje de esta gua. Fecha de entrega: 12/Abril/2011 hasta las 23:55 hrs (Solo aplica para el manual tcnico) 6. GLOSARIO y y y y y Prueba: Proceso en el que se verifica el cumplimiento de un elemento segn requerimientos establecidos y planeacin diseada para la fabricacin de tal elemento Caja negra: Conocido como un proceso de verificacin en el que solo interesan las entradas y las salidas Caja blanca: Conocido como el proceso de verificacin de entradas, salidas y procesamiento Mtricas: Estndares o procesos establecidos y probados que determinan las buenas prcticas en el desarrollo de procedimientos. Formato o plantilla de prueba: Documento que permite organizar la informacin y estandarizarla en el lenguaje establecido por todo el equipo de desarrollo. Permite adems, controlar los procesos de desarrollo de pruebas Informe de prueba: documento que recopila todas las actividades del proceso de pruebas con el fin de determinar acciones correctivas y establecer el estado del proyecto de desarrollo del sistema de informacin.

SERVICIO NACIONAL DE APRENDIZAJE SENA Centro Agropecuario Regional Cauca Programa de Formacin : Anlisis y Desarrollo de Sistemas de informacin
Modelo de Mejora Continua

Fecha: Julio de 2010 Versin 1.0 Pgina 9 de 9

GUA DE APRENDIZAJE Manual Tcnico de mi desarrollo software

7. BIBLIOGRAFIA

y y y

ARJONILLA, Sixto, MEDINA, Jos. La gestin de los sistemas de informacin empresarial 2 Edicin, Editorial Pirmide. Programa de formacin en Tecnlogo en Anlisis y desarrollo de sistemas de informacin Sena. GARCIA, Rodrigo. Elaboracin de Manuales tcnicos. Ubicacin: http://www.mitecnologico.com/Main/ElaboracionManualTecnico

8. CONTROL DEL DOCUMENTO. Nombres Lorena Cern Fabin Andrs Muoz Fecha 02 Abril de 2011

Elaborada por: Validada por (par acadmico)

Justificacin del cambio: