58327309 guia manual tecnico

7/29/2019 58327309 Guia Manual Tecnico

1/9


2/9

Modelo de MejoraContinua

SERVICIO NACIONAL DE APRENDIZAJE SENACentro Agropecuario Regional Cauca

Programa de Formacin : Anlisis y Desarrollo deSistemas de informacin

GUA DE APRENDIZAJEManual Tcnico de mi desarrollo software

Fecha:Julio de 2010

Versin 1.0

Pgina 2 de 9

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 yconcisa, por lo que se debe identificar el equilibrio entre los conceptos tcnicos y una jergaprofesional. As mismo, la didctica que busca la eficiencia en transmitir conocimientos, es unrecurso 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 sumamenteimportante.

Actividad Integradora: Lea y analice de manera activa el documento Elaboracin de ManualesDidcticos y desarrolle los siguientes tems:

y Categorice a la poblacin objetivo quien ser la lectora del manual tcnico (identifiquecaractersticas como estudios u rea de trabajo, nivel de uso de herramientas TICs,carcter o personalidad en general)

y Categorizar el rea de implementacin del sistema de informacin.y 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 tcnicoy Introducciny Justificaciny Objetivos del documentoy Glosario de trminos (para el rea tcnica y trminos relacionados con el software)y Defina el logo, eslogan de su producto softwarey Descripcin general del sistema: este punto esta compuesto por los tems que se


3/9





Fecha:Julio de 2010

Versin 1.0

Pgina 3 de 9

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

describen a continuacin

o Identificacin del sistema: Nombre y siglas que lo identifican.o Objetivos: Descripcin breve del objetivo general del nuevo sistema, incluyendo

referencia a las funciones del negocio (planificacin, gestin, etc) qu cubre y cmolo hace.

o Alcance: Diagrama de contexto1 que muestre la interaccin del sistema con el restode los sistemas de la organizacin.

o Caractersticas generales. Descripcin breve de las siguientes especificacionesfuncionales 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.

o Polticas relacionadas con su uso. Siguiendo las polticas, normas y estndaresvigentes, 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.o 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.o 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 cualquiermedio concertado)

Ambiente(s) requerido:

Ambiente TICs dotado de Equipo s de cmputo y paquete funcional de ofimtica.Material (es) requerido:Instructor (es): Lorena Cern.


4/9





Fecha:Julio de 2010

Versin 1.0

Pgina 4 de 9

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 maneraptima.

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 Nunca existi o se ha perdido!

y Es incompleta o escasa.

y No est actualizada con los cambios que se han ido haciendo al sistema.y Tiene contradicciones con el contenido real del cdigo.

y 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 Logotipo de la organizacin (del proyecto formativo)

y Nombre empresa desarrolladora (Del CEAPS o Proyecto formativo).


5/9





Fecha:Julio de 2010

Versin 1.0

Pgina 5 de 9

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

y Denominacin: Nombre completo del documento

y Lugar y fecha de elaboracin.

y Versin.

y 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 Cdigo del documento (esta denominacin deber indicar la etapa donde se encuentra la

elaboracin del manual y ser construida y explicada por el CEAPs)y 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


6/9


7/9





Fecha:Julio de 2010

Versin 1.0

Pgina 7 de 9

4. REFERENTES DE CONSULTA PARA ACTIVIDADES

y Elaboracin de un manual tcnicoAutor: Instituto tcnico de capacitacin y productividad

y Cmo escribir un documento tcnicoAutor: Enrique Alba Departamento de lenguaje y Ciencias de la Computacin de laUniversidad de Mlaga - Espaa

y Diagramas UMLhttp://jaimemontoya.com/informaticsprojects/diagramasuml.php

y Diagrama de contexto, mayor informacin http://sisab.lce.org/~yavier/Analisis.htmly Material para documentar el manual tcnico Autora: Lorena Cern

y 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)

y ACTIVIDAD 3: Desarrollen los puntos 1.8 al 1.9

Tiempo estimado para la ACTIVIDAD 2: 4 horas (Da 4)

y ACTIVIDAD 4: Desarrolle el tem 1.10 de la gua.

Tiempo estimado para la ACTIVIDAD: 4 horas (Da 5)

y 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 tcnicoInstructor (es): Lorena Cern.


8/9





Fecha:Julio de 2010

Versin 1.0

Pgina 8 de 9

5. EVALUACION Y EVIDENCIAS

6. GLOSARIO

EVIDENCIA 1: Manual tcnicoCriterios deEvaluacin:

- El manual tcnico de la aplicacin, documentando los procesosinvolucrados en la administracin especializada del sistema deinformacin, segn normas y procedimientos de la organizacin

- Utiliza con criterio tcnico las tecnologas de la informacin y lacomunicacin de acuerdo con las actividades a desarrollar.

- Presenta las evidencias de manera oportuna y de acuerdo con loconcertado.

- Resuelve conflictos mediante el uso de la racionalidad, la argumentacin yla asertividad

Instrumentos deEvaluacin:

Lista de chequeo

Tipo de Evidencia: Desempeo Conocimiento Producto X

Descripcin de laevidencia:

Entregue el manual tcnico del sistema de informacin con cada uno de lostems presentados en la gua de aprendizaje Actividad de Aprendizaje 2Presente mediante acta las firmas de los encargados de la revisin yaprobacin 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 lacarpeta 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)

y Prueba: Proceso en el que se verifica el cumplimiento de un elemento segnrequerimientos establecidos y planeacin diseada para la fabricacin de tal elemento

y Caja negra: Conocido como un proceso de verificacin en el que solo interesan lasentradas y las salidas

y Caja blanca: Conocido como el proceso de verificacin de entradas, salidas yprocesamiento

y Mtricas: Estndares o procesos establecidos y probados que determinan las buenasprcticas en el desarrollo de procedimientos.

y Formato o plantilla de prueba: Documento que permite organizar la informacin y

estandarizarla en el lenguaje establecido por todo el equipo de desarrollo. Permiteadems, controlar los procesos de desarrollo de pruebas

y Informe de prueba: documento que recopila todas las actividades del proceso depruebas con el fin de determinar acciones correctivas y establecer el estado del proyectode desarrollo del sistema de informacin.


9/9





Fecha:Julio de 2010

Versin 1.0

Pgina 9 de 9

7. BIBLIOGRAFIA

y ARJONILLA, Sixto, MEDINA, Jos. La gestin de los sistemas de informacin empresarial2 Edicin, Editorial Pirmide.

y Programa de formacin en Tecnlogo en Anlisis y desarrollo de sistemas de informacinSena.

y GARCIA, Rodrigo. Elaboracin de Manuales tcnicos.Ubicacin: http://www.mitecnologico.com/Main/ElaboracionManualTecnico

8. CONTROL DEL DOCUMENTO.

Nombres Fecha

Elaborada por:Lorena Cern

Fabin Andrs Muoz 02 Abril de 2011

Validada por (paracadmico) Justificacin del cambio:

58327309 guia manual tecnico

Documents