1
Download referencias - Ministerio de Educación
Document related concepts
no text concepts found
Transcript
MINISTERIO DE EDUCACIÓN DIRECCIÓN NACIONAL DE ADMINISTRACIÓN GERENCIA DE SISTEMAS INFORMÁTICOS DOC-DSI-007 “Documento de Diseño” [Versión del Documento] [NOMBRE DEL SISTEMA] [Versión del Sistema] [En caso de Consultoría incluir aquí el nombre del contrato que da origen al documento] Elaborado: Revisado: Aprobado: HISTORIAL DE REVISIONES Fecha Versión 03/03/2011 1.0 12/09/2011 Mayo 2013 1.1 1.2 Julio 2013 1.3 Agosto 2013 1.4 Septiembre 2013 Octubre 2013 Diciembre 2014 1.5 1.6 1.7 Descripción Elaboración de formato del documento. (Versión revisada y aprobada). Se agregó a la portada el ítem “Versión del documento” Se actualizaron los logos y el nombre de la Gerencia. Se aplicaron cambios y correcciones de acuerdo a las observaciones realizadas en el taller del 31/05/2013. Se aplicaron las observaciones realizadas por la Gerencia de Sistemas Informáticos. Se agregó nuevo formato de Diccionario de Clases y su respectivo ejemplo Se corrigió formato de títulos Se actualizó el logo en todo el documento Autor Ing. Xiomara López Ing. Xiomara López Ing. Xiomara López Ing. Xiomara López Ing. Xiomara López Ing. Xiomara López Ing. Xiomara López Ing. Xiomara López LISTA DE DISTRIBUCIÓN Fecha 04/03/2011 Tipo de Documento (Digital o copia impresa) Digital Destinatario Ing. Fátima Rodríguez, Ing. Max Mirón MINISTERIO DE EDUCACIÓN DIRECCIÓN NACIONAL DE ADMINISTRACIÓN GERENCIA DE SISTEMAS INFORMÁTICOS TITULO: Documento de Diseño – [Nombre Del Sistema] [Versión del Sistema] CODIGO: DOC-DSI-007 PROCESOS COBIT: AI2 VERSION: 1.7 Página 3 de 22 ÍNDICE INTRODUCCIÓN _______________________________________________________________ 4 OBJETIVOS ____________________________________________________________________ 5 DEFINICIONES, ACRÓNIMOS Y ABREVIATURAS __________________________________ 6 REFERENCIAS _________________________________________________________________ 7 1. ARQUITECTURA DEL SISTEMA ______________________________________________ 8 2. DIAGRAMA DE PAQUETES __________________________________________________ 9 3. DIAGRAMA DE CLASES ____________________________________________________ 10 4. DICCIONARIO DE CLASES _________________________________________________ 12 5. DIAGRAMA DE DISTRIBUCIÓN O DESPLIEGUE ______________________________ 15 6. DIAGRAMA DE COMPONENTES ____________________________________________ 16 7. DIAGRAMA DE ESTADOS __________________________________________________ 17 8. DIAGRAMAS DE SECUENCIA _______________________________________________ 18 9. DISEÑO DE PROTOTIPO (SALIDAS, ENTRADAS Y PROCESOS) _________________ 19 10. DISEÑO DE SEGURIDAD _________________________________________________ 21 11. ANEXOS ________________________________________________________________ 22 MINISTERIO DE EDUCACIÓN DIRECCIÓN NACIONAL DE ADMINISTRACIÓN GERENCIA DE SISTEMAS INFORMÁTICOS TITULO: Documento de Diseño – [Nombre Del Sistema] [Versión del Sistema] CODIGO: DOC-DSI-007 PROCESOS COBIT: AI2 VERSION: 1.7 Página 4 de 22 INTRODUCCIÓN (Proporcionar un panorama completo del Documento de Diseño) Se sugiere que en la redacción de la introducción se aclare la siguiente información: 1. ¿En qué consiste el trabajo? (Descripción general) 2. ¿Por qué se hace? (Propósitos u objetivos del trabajo) 3. ¿Para qué se realiza? (Razones que justifican el trabajo – importancia) 4. ¿Cómo se hizo?: (Metodología, pasos, etapas o procedimientos utilizados) 5. ¿A quién se dirige? (opcional) 6. ¿Cómo está organizado? (opcional) MINISTERIO DE EDUCACIÓN DIRECCIÓN NACIONAL DE ADMINISTRACIÓN GERENCIA DE SISTEMAS INFORMÁTICOS TITULO: Documento de Diseño – [Nombre Del Sistema] [Versión del Sistema] CODIGO: DOC-DSI-007 PROCESOS COBIT: AI2 VERSION: 1.7 Página 5 de 22 OBJETIVOS (Objetivos del Documento de Diseño) Se sugiere que en la redacción de los objetivos se sigan las siguientes indicaciones: 1. Iniciar redacción utilizando un verbo en forma infinitiva, ej.: Identificar, Aplicar, etc. (Este verbo describe el QUÉ del objetivo). 2. Para completar el enunciado del objetivo se da respuesta al PARA QUE del propósito. (finalidad del objetivo). 3. Termina enunciando el CÓMO se logrará el objetivo, ej.: mediante, a través de, utilizando. GENERAL: ESPECÍFICOS: MINISTERIO DE EDUCACIÓN DIRECCIÓN NACIONAL DE ADMINISTRACIÓN GERENCIA DE SISTEMAS INFORMÁTICOS TITULO: Documento de Diseño – [Nombre Del Sistema] [Versión del Sistema] CODIGO: DOC-DSI-007 PROCESOS COBIT: AI2 VERSION: 1.7 Página 6 de 22 DEFINICIONES, ACRÓNIMOS Y ABREVIATURAS (Definición de todos los términos, abreviaturas y acrónimos necesarios para interpretar apropiadamente este documento) Plantilla Utilizar el siguiente formato: [Término:] Definición [Abreviatura:] Definición [Acrónimo:] Definición Ejemplo MVC: Modelo Vista Controlador. MINISTERIO DE EDUCACIÓN DIRECCIÓN NACIONAL DE ADMINISTRACIÓN GERENCIA DE SISTEMAS INFORMÁTICOS TITULO: Documento de Diseño – [Nombre Del Sistema] [Versión del Sistema] CODIGO: DOC-DSI-007 PROCESOS COBIT: AI2 VERSION: 1.7 Página 7 de 22 REFERENCIAS (Relación completa de todos los documentos relacionados en el “Documento de Diseño”, identificando de cada documento la referencia (si procede), el titulo, la ruta, fecha y organización que lo proporciona) Plantilla Utilizar el siguiente formato: Referencia [Ref.] Titulo [Título] Ruta o Ubicación [Ruta] Fecha [Fecha] Titulo Manual de Desarrollo de Sistemas Ruta o Ubicación Intranet Fecha 25/01/2011 Autor [Autor] Ejemplo Referencia MAN-GSI-002 Autor Departamento de Sistemas - Gerencia de Informática MINISTERIO DE EDUCACIÓN DIRECCIÓN NACIONAL DE ADMINISTRACIÓN GERENCIA DE SISTEMAS INFORMÁTICOS TITULO: Documento de Diseño – [Nombre Del Sistema] [Versión del Sistema] CODIGO: DOC-DSI-007 PROCESOS COBIT: AI2 VERSION: 1.7 Página 8 de 22 1. ARQUITECTURA DEL SISTEMA (Indicar la descripción requerida, si el sistema es Cliente – Servidor, Web o Hibrido) Ejemplo El sistema utiliza la arquitectura MVC descrita a continuación: Arquitectura MVC El patrón de diseño MVC organiza el código en base a su función. De hecho, este patrón separa el código en tres capas: La capa del modelo define la lógica de negocio (la base de datos pertenece a esta capa). La vista es lo que utilizan los usuarios para interactuar con la aplicación. El controlador es un bloque de código que realiza llamadas al modelo para obtener los datos y se los pasa a la vista para que los muestre al usuario. MINISTERIO DE EDUCACIÓN DIRECCIÓN NACIONAL DE ADMINISTRACIÓN GERENCIA DE SISTEMAS INFORMÁTICOS TITULO: Documento de Diseño – [Nombre Del Sistema] [Versión del Sistema] CODIGO: DOC-DSI-007 PROCESOS COBIT: AI2 VERSION: 1.7 Página 9 de 22 2. DIAGRAMA DE PAQUETES (El detalle y uso de este tipo de diagrama dependerá de la complejidad del sistema) El diagrama de paquetes muestra cómo un sistema está dividido en agrupaciones lógicas mostrando las dependencias entre esas agrupaciones. Ejemplo En el caso de un sistema Web, se tiene el siguiente diagrama: MINISTERIO DE EDUCACIÓN DIRECCIÓN NACIONAL DE ADMINISTRACIÓN GERENCIA DE SISTEMAS INFORMÁTICOS TITULO: Documento de Diseño – [Nombre Del Sistema] [Versión del Sistema] CODIGO: DOC-DSI-007 PROCESOS COBIT: AI2 VERSION: 1.7 Página 10 de 22 3. DIAGRAMA DE CLASES El diagrama de clases describe la estructura estática del sistema. Muestra las clases, sus contenidos y sus relaciones. Ejemplo MINISTERIO DE EDUCACIÓN DIRECCIÓN NACIONAL DE ADMINISTRACIÓN GERENCIA DE SISTEMAS INFORMÁTICOS TITULO: Documento de Diseño – [Nombre Del Sistema] [Versión del Sistema] CODIGO: DOC-DSI-007 PROCESOS COBIT: AI2 VERSION: 1.7 Página 11 de 22 TipoCliente - idTipoCliente : java.lang.Integer - nombreTipoCliente : java.lang.String + + + + nuevo () guardar () editar () eliminar () ... : : : : void void void void 1..1 * Cliente Proveedor + + + + + idProveedor nombreProveedor direccionProveedor telefonoProveedor correoProvedor : : : : : Grupo java.lang.Integer java.lang.String java.lang.String java.lang.String java.lang.String nuevo () guardar (Proveedor object) editar (java.lang.Integer idProveedor) eliminar (java.lang.Integer idProveedor) imprimir (java.lang.Integer idProveedor) ... - idGrupo : java.lang.Integer - nombreGrupo : java.lang.String - estadoGrupo : java.lang.Integer : : : : : + + + + + Proveedor Boolean Proveedor Boolean void nuevo () guardar () editar () eliminar () imprimir () ... : : : : : void void void void void 0..1 - idCliente nombreCliente apellidoCliente direccionCliente telefonoCliente correoCliente idTipoCliente + + + + + nuevo () guardar () editar () eliminar () imprimir () ... 1..1 : : : : : : : : : : : : java.lang.Integer java.lang.String java.lang.String java.lang.String java.lang.String java.lang.String java.lang.Integer Empleado TipoVenta - idTipoVenta : java.lang.Integer - nombreTipoVenta : java.lang.String + + + + void void void void void nuevo () guardar () editar () eliminar () ... : : : : void void void void 1..1 + + + + + idCompra idProveedor fechaCompra valorBruto iva valorNeto nuevo () guardar () editar () eliminar () imprimir () ... : : : : : : : : : : : * * Factura Producto Compra - java.lang.Integer java.lang.Number java.util.Date java.lang.Double java.lang.Double java.lang.Double void void void void void + + + + + idProducto idGrupo nombreProducto stockMinimo stockMaximo existencia estadoProducto nuevo () guardar () editar () eliminar () imprimir () ... : : : : : : : : : : : : java.lang.Integer java.lang.Integer java.lang.String java.lang.Integer java.lang.Integer java.lang.Integer java.lang.Number * void void void void void 1..1 1..1 * DetalleCompra + + + + + + idDetalleCompra idCompra idProducto idCantidad precioUnitario : : : : : : : : : : : * DetalleFactura java.lang.Integer java.lang.Integer java.lang.Integer java.lang.Number java.lang.Double nuevo () guardar () editar () eliminar () imprimir () actualizaExistencia () ... void void void void void java.lang.Integer - idDetallefactura idFactura idProducto cantidad precioUnitario : : : : : + + + + + nuevo () guardar () editar () eliminar () actualizaExistencia () ... java.lang.Integer java.lang.Integer java.lang.Integer java.lang.Number java.lang.Double : : : : : 0..1 0..1 Movimiento 0..* - - idFactura fechaFactura idCliente idEmpleado idTipoVenta valorBruto iva valorNeto + + + + + nuevo () guardar () editar () eliminar () imprimir () ... : : : : : : : : : : : : : java.lang.String java.util.Date java.lang.Integer java.lang.Integer java.lang.Integer java.lang.Double java.lang.Double java.lang.Double void void void void void 1..1 * idMovimiento comprobante fechaMovimiento idProducto idTipoMovimiento + nuevo () : void ... : : : : : java.lang.Integer java.lang.String java.util.Date java.lang.Integer java.lang.Integer idEmpleado nombreEmpleado apellidoEmpleado duiEmpleado + + + + + nuevo () guardar () editar () eliminar () imprimir () ... : : : : : : : : : java.lang.Integer java.lang.String java.lang.String java.lang.String void void void void void 0..1 0..1 * - 0..* void void void void java.lang.Integer * MINISTERIO DE EDUCACIÓN DIRECCIÓN NACIONAL DE ADMINISTRACIÓN GERENCIA DE SISTEMAS INFORMÁTICOS TITULO: Documento de Diseño – [Nombre Del Sistema] [Versión del Sistema] CODIGO: DOC-DSI-007 PROCESOS COBIT: AI2 VERSION: 1.7 Página 12 de 22 4. DICCIONARIO DE CLASES Plantilla Utilizar el siguiente formato para cada clase: 4.1. Clase: [Nombre de la Clase] 4.1.1. Ficha técnica de la Clase: [Nombre de la Clase] Nombre: Código: Tipo Objeto: Visibilidad: Comentario: 4.1.2. Lista de atributos de la clase: [Nombre de la Clase] Nombre Código Tipo Dato Java Visibilidad Comentario 4.1.3. Lista de métodos de la clase: [Nombre de la Clase] Nombre Código Retorna Visibilidad Abstracta Final Estática Comentario 4.1.4. Lista de asociaciones de la clase: [Nombre de la Clase] Clase padre Cardinalidad padre Clase dependiente Cardinalidad dependiente Descripción MINISTERIO DE EDUCACIÓN DIRECCIÓN NACIONAL DE ADMINISTRACIÓN GERENCIA DE SISTEMAS INFORMÁTICOS TITULO: Documento de Diseño – [Nombre Del Sistema] [Versión del Sistema] CODIGO: DOC-DSI-007 PROCESOS COBIT: AI2 VERSION: 1.7 Página 13 de 22 Ejemplo Véase el siguiente ejemplo para el diagrama de clases mostrado en el tema anterior: 4.1. Clase: Proveedor 4.1.1. Ficha técnica de la Clase: Proveedor Nombre: Código: Tipo Objeto: Visibilidad: Comentario: Proveedor Proveedor Class public Clase contenedora de los proveedores del MINED 4.1.2. Lista de atributos de la clase: Proveedor Nombre Código Tipo Dato Java Visibilidad idProveedor idProveedor java.lang.Integer private nombreProveedor nombreProveedor java.lang.String private direccionProveedor direccionProveedor java.lang.String private telefonoProveedor telefonoProveedor java.lang.String private correoProvedor correoProvedor java.lang.String private Comentario Atributo para almacenar el identificador del proveedor Atributo para almacenar el nombre del proveedor Atributo para almacenar la dirección de las oficinas del proveedor Atributo para almacenar el número telefónico del proveedor Atributo que almacena el correo electrónico del proveedor MINISTERIO DE EDUCACIÓN DIRECCIÓN NACIONAL DE ADMINISTRACIÓN GERENCIA DE SISTEMAS INFORMÁTICOS TITULO: Documento de Diseño – [Nombre Del Sistema] [Versión del Sistema] CODIGO: DOC-DSI-007 PROCESOS COBIT: AI2 VERSION: 1.7 Página 14 de 22 4.1.3. Lista de métodos de la clase: Proveedor Nombre Código Retorna Visibilidad nuevo nuevo Proveedor public guardar guardar Boolean public editar editar Proveedor public eliminar eliminar Boolean public imprimir imprimir void public Abstracta Final Estática Comentario Método para agregar un nuevo proveedor Método para almacenar un nuevo proveedor o la modificación a un proveedor Método para editar un proveedor existente Método para eliminar un proveedor Método para imprimir la información de un proveedor 4.1.4. Lista de asociaciones de la clase: Proveedor Clase padre Proveedor Cardinalidad padre 1..1 Clase dependiente Compra Cardinalidad dependiente * Descripción MINISTERIO DE EDUCACIÓN DIRECCIÓN NACIONAL DE ADMINISTRACIÓN GERENCIA DE SISTEMAS INFORMÁTICOS TITULO: Documento de Diseño – [Nombre Del Sistema] [Versión del Sistema] CODIGO: DOC-DSI-007 PROCESOS COBIT: AI2 VERSION: 1.7 Página 15 de 22 5. DIAGRAMA DE DISTRIBUCIÓN O DESPLIEGUE (El detalle y uso de este tipo de diagrama dependerá de la complejidad del sistema) Diagrama que se utiliza para modelar el hardware utilizado en las implementaciones de sistemas y las relaciones entre sus componentes Ejemplo MINISTERIO DE EDUCACIÓN DIRECCIÓN NACIONAL DE ADMINISTRACIÓN GERENCIA DE SISTEMAS INFORMÁTICOS TITULO: Documento de Diseño – [Nombre Del Sistema] [Versión del Sistema] CODIGO: DOC-DSI-007 PROCESOS COBIT: AI2 VERSION: 1.7 Página 16 de 22 6. DIAGRAMA DE COMPONENTES (El detalle y uso de este tipo de diagrama dependerá de la complejidad del sistema) Este diagrama muestra las dependencias lógicas entre componentes software, sean éstos componentes fuentes, binarios o ejecutables, Ejemplo MINISTERIO DE EDUCACIÓN DIRECCIÓN NACIONAL DE ADMINISTRACIÓN GERENCIA DE SISTEMAS INFORMÁTICOS TITULO: Documento de Diseño – [Nombre Del Sistema] [Versión del Sistema] CODIGO: DOC-DSI-007 PROCESOS COBIT: AI2 VERSION: 1.7 Página 17 de 22 7. DIAGRAMA DE ESTADOS (El detalle y uso de este tipo de diagrama dependerá de la complejidad del sistema) Este diagrama describe los estados que pueden tener un objeto o interacción, así como las transiciones entre dichos estados. Ejemplo Diagrama de Estados del Proceso de Recepción de Datos MINISTERIO DE EDUCACIÓN DIRECCIÓN NACIONAL DE ADMINISTRACIÓN GERENCIA DE SISTEMAS INFORMÁTICOS TITULO: Documento de Diseño – [Nombre Del Sistema] [Versión del Sistema] CODIGO: DOC-DSI-007 PROCESOS COBIT: AI2 VERSION: 1.7 Página 18 de 22 8. DIAGRAMAS DE SECUENCIA (El detalle y uso de este tipo de diagrama dependerá de la complejidad del sistema) Este tipo de diagramas muestra una interacción ordenada según la secuencia de eventos vista a la luz de una línea de tiempo. En particular, se muestran los objetos participantes en la interacción y los mensajes que intercambian ordenados según su secuencia en el tiempo. Ejemplo Diagrama de Secuencia de Registro de Usuarios MINISTERIO DE EDUCACIÓN DIRECCIÓN NACIONAL DE ADMINISTRACIÓN GERENCIA DE SISTEMAS INFORMÁTICOS TITULO: Documento de Diseño – [Nombre Del Sistema] [Versión del Sistema] CODIGO: DOC-DSI-007 PROCESOS COBIT: AI2 VERSION: 1.7 Página 19 de 22 9. DISEÑO DE PROTOTIPO (SALIDAS, ENTRADAS Y PROCESOS) (Desarrollar este tema en caso de que el prototipo elaborado en el “Documento de Requerimientos” haya quedado pobre o escueto) Plantilla Utilizar el siguiente formato: No. Nombre de la Pantalla: [Nombre de la Pantalla] C.U. de Referencia: [Número y nombre del Caso de Uso de Referencia] Descripción: [Breve descripción de la Pantalla] Imagen de la Pantalla Dato Datos de la Pantalla (Opcional) Tipo de Dato MINISTERIO DE EDUCACIÓN DIRECCIÓN NACIONAL DE ADMINISTRACIÓN GERENCIA DE SISTEMAS INFORMÁTICOS TITULO: Documento de Diseño – [Nombre Del Sistema] [Versión del Sistema] CODIGO: DOC-DSI-007 PROCESOS COBIT: AI2 VERSION: 1.7 Página 20 de 22 Ejemplo Véase el siguiente ejemplo: No. 2 Nombre de la Pantalla: Ingreso al Sistema C.U. de Referencia: Caso de Uso # 02 – Ingreso al sistema Descripción: Pantalla de bienvenida que se muestra al ingresar al sistema. Datos de la Pantalla (Opcional) Dato Tipo de Dato Usuario Texto Clave Texto, Numérico MINISTERIO DE EDUCACIÓN DIRECCIÓN NACIONAL DE ADMINISTRACIÓN GERENCIA DE SISTEMAS INFORMÁTICOS TITULO: Documento de Diseño – [Nombre Del Sistema] [Versión del Sistema] CODIGO: DOC-DSI-007 PROCESOS COBIT: AI2 VERSION: 1.7 Página 21 de 22 10. DISEÑO DE SEGURIDAD (Desarrollar este tema en el caso de que en el “Documento de Requerimientos” haya quedado pobre o escueto) En esta sección se debe especificar el diseño de los mecanismos de seguridad a utilizar, incluyendo la forma de comunicación con esquemas o componentes existentes. El diseño de la seguridad está relacionado con la confidencialidad de los datos en la transmisión y en el almacenamiento, junto con las necesidades del sistema para evitar intrusiones no autorizadas al mismo y la capacidad para seguir eventos que comprometan esta seguridad a través del tiempo. Los ítems que se consideran para esta categoría son los siguientes: Presentar procesos de autenticación al sistema Empleo de canales seguros Almacenamiento cifrado para información de acceso al sistema Uso de sesiones de usuario Capacidad para realizar auditoria al sistema Necesidad del sistema de utilizar un esquema de seguridad existente. Ejemplo: El acceso a las opciones de modificación de datos podrá realizarse únicamente después de una autenticación de usuario y el acceso a dichas opciones estará restringido por el tipo de usuario. MINISTERIO DE EDUCACIÓN DIRECCIÓN NACIONAL DE ADMINISTRACIÓN GERENCIA DE SISTEMAS INFORMÁTICOS TITULO: Documento de Diseño – [Nombre Del Sistema] [Versión del Sistema] CODIGO: DOC-DSI-007 PROCESOS COBIT: AI2 VERSION: 1.7 Página 22 de 22 11. ANEXOS (Formularios o documentos utilizados para el estudio)
