DOCUMENTACION DE ARQUITECTURA INTRODUCCION ELSA ESTEVEZ UNIVERSIDAD NACIONAL DEL SUR DEPARTAMENTO DE CIENCIAS E INGENIERIA DE LA COMPUTACION

DOCUMENTACION DE ARQUITECTURA INTRODUCCION ELSA ESTEVEZ UNIVERSIDAD NACIONAL DEL SUR DEPARTAMENTO DE CIENCIAS E INGENIERIA DE LA COMPUTACION

CONTENIDO 1 DOCUMENTACION Mtivación Audiencia y uss Recmendacines Vistas 2 REVISION DE CONCEPTOS Arquitectura y Diseñ de Sistemas Bahía Blanca 09 de may de 2018 2

MOTIVACION 1 La mejr arquitectura será inútil si quienes deben usarla: n saben de qué se trata n entiende cóm se usa, cnstruye mdifica la entienden mal y la aplican incrrectamente Crear una arquitectura n es suficiente, debe ser bien cmunicada: se debe permitir que ls interesads la usen aprpiadamente para hacer su trabaj se debe describir la arquitectura cn el suficiente detalle, sin ambigüedad y de manera rganizada para que trs puedan rápidamente encntrar la infrmación que necesitan Arquitectura y Diseñ de Sistemas Bahía Blanca 09 de may de 2018 3

MOTIVACION 2 En td mment, la dcumentación habla pr el arquitect: HOY - cuand el arquitect puede hacer tras tareas relevantes en vez de respnder preguntas sbre la arquitectura. MAÑANA - cuand el arquitect haya dejad el pryect y alguien más se encargue de su evlución y mantenimient Usualmente se hace prque alguien/alg la requiere - un cntrat, un cliente, el prces estándar de la empresa, etc. Arquitectura y Diseñ de Sistemas Bahía Blanca 09 de may de 2018 4

ARGUMENTOS Pr qué ls arquitects deberían invertir tiemp en dcumentar la arquitectura? es esencial para prducir un prduct de alta calidad, predecible, y cn el menr re-trabaj psible ls interesads inmediats analistas, desarrlladres, respnsables de testing, instaladres; la necesitan prque les aprta valr a ells misms permite mantener ls resultads de las principales decisines de diseñ ayuda a que el prces de diseñ sea más sistemátic y sin prblemas ayuda a raznar sbre la arquitectura y a cmunicarla mientras se trabaja sbre ella. Arquitectura y Diseñ de Sistemas Bahía Blanca 09 de may de 2018 5

USOS Element de educación Permite intrducir el sistema a tras persnas - nuevs miembrs del equip, nuevs analistas externs, el cliente que está cnciend la slución pr primera vez Element de cmunicación un de ls principales usuaris es el arquitect, el mism que la cnstruyó nuevs l ayuda en el prces de definición de la arquitectura Registr de las decisines de diseñ Ayuda a determinar el prgres (detectar ls TBD t be decided y TD) Element de cntrl Sirve de base para el análisis y la cnstrucción del sistema: le dice a ls desarrlladres cóm tienen que cnstruir prvee infrmación sbre atributs de calidad a aquells que tienen que evaluarls Arquitectura y Diseñ de Sistemas Bahía Blanca 09 de may de 2018 6

AUDIENCIA Y USOS 1 ROL DESCRIPCION USO Arquitect Desarrlla y dcumenta la arquitectura Negciar requerimients cntrapuests Elegir entre alternativas de diseñ Mantener repsitri de decisines de diseñ Mstrar evidencia que la arquitectura satisface ls requerimients Gerente de Negci Administra una unidad de negci Entender la capacidad del sistema para alcanzar las metas del negci Analista de Calidad Asegura el cumplimient de estándares y prcess Base para cntrlar que la implementación siguió ls prescripcines de la arquitectura Administradres de Base de Dats Administra aspects del almacenamient de dats Entender cm ls dats sn creads y actualizads pr ls cmpnentes de la arquitectura Arquitectura y Diseñ de Sistemas Bahía Blanca 09 de may de 2018 7

AUDIENCIA Y USOS 2 ROL DESCRIPCION USO Instaladres Instala y pne en marcha el sistema Entender ls elements de la arquitectura que se entregan y tienen que ser instalads Diseñadres Diseña el sftware a mas baj nivel que la arquitectura Aplica la arquitectura para cumplir ls requerimients Reslver asignación de recurss Establecer presupuests para el cnsum de recurss Entender cm un cmpnentes se cmunicará cn trs cmpnentes del sistema Mantenimient Crrige bugs Desarrlla mejras Entender las ramificacines de un cambi Administradr de Red Mantiene el hardware y sftware de una red Determinar la carga de la red en distints escenaris de us Arquitectura y Diseñ de Sistemas Bahía Blanca 09 de may de 2018 8

AUDIENCIA Y USOS 3 ROL DESCRIPCION USO Gerente de Pryect Planifica pryect Asigna recurss Ayudar a calcular el presupuest Ayudar a medir el prgres cn respect a la planificación Representante de Sistemas Externs Respnsable del sistema cn el cual se debe interperar Definir el cnjunt de acuerds entre ls sistemas Testeadr Respnsable pr el test y verificación del sistema Crear tests basads en el cmprtamient y la interacción de ls cmpnentes de sftware Usuari Usuari final del sistema. Puede haber varis tips de usuaris Entender cuales sn ls principales cmpnentes del sistema para cmprender diferentes situacines que pudieran afectarl Arquitectura y Diseñ de Sistemas Bahía Blanca 09 de may de 2018 9

DOCUMENTACION DE ATRIBUTOS DE CALIDAD Cualquier patrón estil arquitectónic utilizad tendrá atributs de calidad asciads. Al explicar la elección, se debe incluir una discusión sbre la satisfacción de ls requerimients de atributs de calidad y de ls trade-ffs incurrids Pr ejempl, en la sección Justificación Alguns elements de la arquitectura que prveen un servici, tienen límites en determinads atributs de calidad. Ests límites deben definirse en la dcumentación de la interfaz del element. Pr ejempl, Cntrat de Calidad de Servici Ls atributs de calidad generalmente imparten un lenguaje pr el cual se pdría buscar. Alguien cn cncimient en el atribut de calidad, puede buscar pr ls elements de la arquitectura (y sus prpiedades) que referencian al atribut de calidad su jerga relacinada. Arquitectura y Diseñ de Sistemas Bahía Blanca 09 de may de 2018 10

DOCUMENTACION DE ATRIBUTOS DE CALIDAD MAPEO La dcumentación de arquitectura frecuentemente cntiene un mape a requerimients (incluyend requerimients de atributs de calidad) que muestra cóm ls requerimients sn satisfechs. Cada atribut de calidad tendrá un cnjunt de interesads que desea cncer cóm se satisface. Se pdría prveer un lugar en la intrducción de la dcumentación para indicarle a cada interesad dónde encntrar l que es de su interés. Sección Radmap Infrmación para X, Infrmación para Y Arquitectura y Diseñ de Sistemas Bahía Blanca 09 de may de 2018 11

DOCUMENTACION - RECOMENDACIONES 1. Escribir la dcumentación desde el punt de vista del lectr 2. Evitar repetición innecesaria 3. Explicar las ntacines 4. Usar un template estándar 5. Registrar las justificacines 6. Mantener la dcumentación actualizada, per n tant 7. Revisar la dcumentación para asegurar que es aprpiada Arquitectura y Diseñ de Sistemas Bahía Blanca 09 de may de 2018 12

VISTAS El cncept de vista es el principi fundamental para rganizar la dcumentación de arquitectura: además de las vistas, incluye infrmación adicinal que pertenece al dcument de arquitectura n es un métd n incluye una secuencia de pass a seguir es una clección de técnicas que llevan una filsfía subyacente: La dcumentación de arquitectura debe ser útil a las persnas que dependen de ella para realizar su trabaj Arquitectura y Diseñ de Sistemas Bahía Blanca 09 de may de 2018 13

TECNICAS Detectar las necesidades de ls interesads Prveer infrmación para dichas necesidades, registrand decisines de diseñ de acuerd a una variedad de vistas mas infrmación adicinal Actividades durante el diseñ de la arquitectura Verificar la dcumentación resultante para determinar si satisface las necesidades Empaquetar la infrmación de una manera útil para ls interesads Actividades centradas en la dcumentación Arquitectura y Diseñ de Sistemas Bahía Blanca 09 de may de 2018 14

NOTACIONES 1) Ntacines infrmales 2) Ntacines semi-frmales 3) Ntacines frmales Arquitectura y Diseñ de Sistemas Bahía Blanca 09 de may de 2018 15

NOTACIONES INFORMALES vistas representadas usand diagramas de prpósit general la semántica de la descripción está en lenguaje natural y n puede ser frmalmente analizada ejempl: PwerPint Arquitectura y Diseñ de Sistemas Bahía Blanca 09 de may de 2018 16

NOTACIONES SEMI-FORMALES las vistas se expresan en una ntación estandarizada que utiliza elements gráfics y reglas de cnstrucción n prvee un tratamient semántic cmplet del significad de ls elements ejempl: UML Arquitectura y Diseñ de Sistemas Bahía Blanca 09 de may de 2018 17

NOTACIONES FORMALES las vistas sn descriptas en una ntación que tiene una semántica precisa (generalmente basada en matemáticas) es psible un análisis frmal tant sintáctic cm semántic cncidas cm Architecture Descriptin Languages (ADLs), prveen un vcabulari gráfic y una semántica subyacente para representar arquitecturas sprtan autmatización a través de herramientas asciadas Ref: http://www-2.dc.uba.ar/prfesres/nick/jacal.htm Arquitectura y Diseñ de Sistemas Bahía Blanca 09 de may de 2018 18

DOCUMENTACION POR VISTAS Dcumentar una arquitectura es una cuestión de dcumentar las vistas relevantes y lueg agregar dcumentación que aplique a más de una vista. Cuáles sn las vistas relevantes? depende de las metas que se establezcan - Cuál es el bjetiv de la dcumentación y a quién va dirigida determinads atributs de calidad sn expuests mejr pr ciertas vistas cada vista enfatiza cierts aspects del sistema, mientras des-enfatiza ignra trs, cn el bjetiv de hacer el prblema tratable Tips de Vistas Vistas de móduls Vistas de cmpnentes y cnectres Vistas de alcación. Arquitectura y Diseñ de Sistemas Bahía Blanca 09 de may de 2018 19

UN SISTEMA VARIAS VISTAS Un arquitect examina el sistema en tres vistas: 1) Cm esta estructurad cm un cnjunt de unidades de cdig? Vista de Móduls 2) Cm esta estructurad cm un cnjunt de elements que tienen cmprtamient e interaccines en tiemp de ejecucin? Vista de Cmpnentes y Cnectres 3) Cm se relacina cn trs elements n de sftware tales cm hardware y equips de desarrll? Vista de Despliegue Arquitectura y Diseñ de Sistemas Bahía Blanca 09 de may de 2018 20

UN SISTEMA VARIAS VISTAS Arquitectura y Diseñ de Sistemas Bahía Blanca 09 de may de 2018 21

VISTAS DE UNA ARQUITECTURA 1 Qué cntiene la dcumentación de un vista? una presentación primaria, usualmente gráfica, mstrand ls principales elements y las relacines de la vista un catálg de elements que explica y define ls elements mstrads en la vista y lista sus prpiedades una especificación de las interfaces y cmprtamient de dichs elements. indicacines sbre ls mecanisms incrprads que permitirían adaptar la arquitectura justificación e infrmación de diseñ Arquitectura y Diseñ de Sistemas Bahía Blanca 09 de may de 2018 22

VISTAS DE UNA ARQUITECTURA 2 Qué cntiene la infrmación que aplica a tdas las vistas? una intrducción al paquete enter, incluyend una guía de lectr que ayuda a ls interesads a encntrar rápidamente la infrmación que necesitan infrmación describiend cóm las vistas se relacinan entre sí y cn el sistema cm un td restriccines y justificacines para la arquitectura glbal Arquitectura y Diseñ de Sistemas Bahía Blanca 09 de may de 2018 23

CONTENIDO 1 DOCUMENTACION Mtivación Audiencia y uss Recmendacines Vistas 2 REVISION DE CONCEPTOS Arquitectura y Diseñ de Sistemas Bahía Blanca 09 de may de 2018 24

DISCUSION - 1 Analizar la utilidad n de este dcument técnic. Justificar Arquitectura y Diseñ de Sistemas Bahía Blanca 09 de may de 2018 25

DISCUSION 2 Identificar un sistema 1) Enumerar cinc aspects de la arquitectura y justificar pr que l sn 2) Enumerar cinc aspects que n sn de arquitectura y justificar pr que n l sn Arquitectura y Diseñ de Sistemas Bahía Blanca 09 de may de 2018 26

DISCUSION 3 1) Qué significa esta imagen? 2) Qué tip de elements muestra - de estructura, de cmprtamient ambs? 3) Cuales sn ls elements del sistema? 4) Que calidades de la ntación hacen que la imagen sea mas mens cmprensible? 5) Quienes sn ls interesads de esta imagen? 6) Qué atributs de calidad intenta satisfacer? 7) Cóm la validaría para asegurar que satisface ls requerimients? Arquitectura y Diseñ de Sistemas Bahía Blanca 09 de may de 2018 27

Elsa Estevez ece@cs.uns.edu.ar