Plantilla Documento de Arquitectura

[Empresa contratante]
Arquitectura y Estandares generales para el sistema [Nombre del sistema a desarrollar]
Arquitectura de Sistema Versin 1.1
Arquitectura y Estandares generales para el sistema [Nombre del sistema a desarrollar] Arquitectura de Sistema
Versin: [No. versin] [dd/mm/yyyy] Pgina 3
Historial de Revisiones Fecha Versin Descripcin Elabor Aprob
3 de 58
TABLA DE CONTENIDO
Introduccin................................................................................................................................................................................................6 Lista de supuestos del proyecto..................................................................................................................................................................7 Descripcin de la solucin del sistema......................................................................................................................................................8 Descripcin de la arquitectura global de las aplicaciones........................................................................................................................9
1.1 Definicin de las capas............................................................................................................................................................11 1.2 Aplicacin [Nombre de la aplicacin].....................................................................................................................................14 1.3 Aplicacin de Lgica de Negocio............................................................................................................................................14 1.4 Capa de integracin y acceso de datos..................................................................................................................................14 1.5 Consideraciones adicionales..................................................................................................................................................14
Requerimientos No funcionales...............................................................................................................................................................15
1.6 Caractersticas tangibles.........................................................................................................................................................15 1.7 Caractersticas de evolucin...................................................................................................................................................15 1.8 Caractersticas de operacin ..................................................................................................................................................15
Consideraciones de seguridad del sistema...............................................................................................................................................17 Consideraciones de Auditoria del Sistema..............................................................................................................................................18 Definiciones de codificacin....................................................................................................................................................................19
1.9 Version de programacin........................................................................................................................................................19
4 de 58
1.10 Manejo de Excepciones.........................................................................................................................................................19 1.11 Manejo de Log y seguimiento de procesos..........................................................................................................................20 1.12 Configuracin de Log............................................................................................................................................................20 1.13 Manejo de auditoria del sistema............................................................................................................................................20 1.14 Validacin..............................................................................................................................................................................20 1.15 Capa de Acceso a datos........................................................................................................................................................21
Alternativas De Emergencia (Work-Arounds)........................................................................................................................................22 Librerias y frameworks del Sistema.........................................................................................................................................................23 ANEXO 1 Glosario...................................................................................................................................................................................24
5 de 58
Introduccin En este documento se describir la definicin de la arquitectura general planteada para el sistema en funcin de la tecnologa seleccionada, las restricciones y los requerimientos no funcionales identificados durante el levantamiento de informacin. El documento es de carcter tcnico y esta dirigido a personas con conocimiento en el lenguaje de programacin [Nombre del lenguaje de programacin], en la plataforma [Nombre de la plataforma] y en tecnologas orientadas a la creacin de aplicaciones empresariales en entornos [Nombre de los entornos]. El documento se divide en las siguientes secciones: Lista supuestos del proyecto, la arquitectura propuesta depende de informacin levantada sobre las necesidades y ambiente en que se va a ejecutar el sistema Descripcin de la solucin del Sistema, en este apartado se muestran los diagramas UML que muestran el esquema general de distribucin de aplicaciones y componentes, y las tecnologas, APIs y protocolos de comunicacin establecidos. Tambin se incluye una breve explicacin de la informacin incluida. Descripcin de la arquitectura global de las aplicaciones. Lista de riesgos, se adjunta la enumeracin de algunos riesgos dentro del proyecto, identificados en la realizacin de este documento y los planes de contingencia propuestos. Requerimientos no funcionales. Consideraciones de seguridad del sistema. Definiciones de codificacin. La ltima seccin corresponde a las definiciones de codificacin que se deben seguir en la realizacin del proyecto. Anexo 1. Glosario.
Lista de supuestos del proyecto La siguiente lista se defini con base en la documentacin existente del proyecto. [Se debe definir: la modalidad del sistema Los recursos que necesita para ser utilizada. El ambiente de ejecucin del sistema(Motor de Base de datos, Sistema opertativo del servidor, servidor de aplicaciones, capacidad en disco, etc) Politicas de seguridad Herramientas a utilizar para el desarrollo del sistema ]
Descripcin de la solucin del sistema La siguiente figura muestra el esquema de configuracin establecido para el sistema. [Ejemplo de esquema:
Definicin de los mdulos del Sistema] [Descripcin del esquema]
Descripcin de la arquitectura global de las aplicaciones La siguiente figura muestra el diseo de la arquitectura de alto nivel del sistema, all se incluyen las tecnologas sobre las que se ha decidido implementar la solucin: [Ejemplo del deiseo de la arquitectura
Cuya implementacin especializada para el proyecto se representa de la siguiente manera: [ Ejemplo de implementacin
[Descripcin de la arquitectura, distribucin de las capas y descripcin general de cada una, descripcin general de la implementacin]
1.1
Definicin de las capas
[Ejemplo del diagrama de Deployment
Diagrama de deployment, Configuracin en la que se va a realizar la instalacin del proyecto actual [Descripcin del diagrama y forma de operacin, definicin de los POM]
[Ejemplo del diagrama de las capas fsica y lgica]
11 de 58
Diagrama de capas lgicas y fsicas [Descripcin del diagrama ]
[ejemplo del diagrama de componentes]
12 de 58
Diagrama de componentes, distribucin de los componentes en los que se apoyara el sistema [Descripcin detallada del diagrama de componentes]
13 de 58
1.2
Aplicacin [Nombre de la aplicacin]
[Diagrama y Descripcin del comportamiento de la aplicacin ]
1.3
Aplicacin de Lgica de Negocio
[Descripcin de la implementacin de la lgica de negocio, patrones a utilizar, descripcin de cada patrn]
1.4
Capa de integracin y acceso de datos
[Descripcin de la capa de persistencia]
1.5
Consideraciones adicionales
[Informacin adicional sobre la implemetnacin que deba ser tenida en cuenta y no se haya especificado en ningun otro item del documento]
14 de 58
Requerimientos No funcionales A continuacin se enumeran los requerimientos no funcionales tenidos en cuenta en la definicin de la arquitectura. En el documento adicional Requerimientos no funcionales, se encuentran definidos todos requerimientos no funcionales para la aplicacin.
1.6
Caractersticas tangibles Rendimiento: conseguir el tiempo mnimo y/o mximo (permitido) en la respuesta de un proceso. Disponibilidad: necesidad de acceso a la informacin en cualquier momento. Usabilidad, facilidad de realizacin de la operacin (Tipo de perfil de usuario al que se orienta el caso de uso, tcnico, conocedor de la lgica etc.)
1.7
Caractersticas de evolucin Escalabilidad: permite capacidad de crecimiento. Flexibilidad: dar la posibilidad de requerimientos y/o reglas de negocio cambiantes con el tiempo Reusabilidad: dar posibilidad de utilizacin de la funcionalidad en otros contextos Extensibilidad: dar posibilidad de adicin de funcionalidad
1.8
Caractersticas de operacin Frecuencia: se considera la cantidad de invocaciones del caso de uso en un periodo de tiempo Seguridad: garantizar restricciones necesarias para la ejecucin del caso de uso, perfiles con acceso, necesidad de encriptamiento o de establecimiento de canales seguros para la transmisin de la informacin
15 de 58
Transaccionalidad: alcance transaccional de las operaciones, completo o parcial. Concurrencia: acceso para consulta o modificacin de datos en el mismo instante de tiempo
Para los casos de uso con requerimientos no funcionales especficos, esta definicin se hace en el entregable de diseo de cada uno de los diferentes mdulos del sistema.
16 de 58
Consideraciones de seguridad del sistema [diagrama del flujo, descripcin del diagrama, descripcin de los frameworks, proceso de administracin y autenticacin del sistema]
17 de 58
Consideraciones de Auditoria del Sistema [Diagrama y descripcin de la estrategia a utilizar para el manejo de la auditoria] [Ejemplo del diagrama utilizado
18 de 58
Definiciones de codificacin
1.9
Version de programacin
[Descripcin de la plataforma a utilizar] 1.10 Manejo de Excepciones El esquema de manejo de excepciones del sistema se contemplar de la siguiente manera. Se establecer dos tipos de excepciones genricas: excepciones de sistema y excepciones de negocio. Todas las excepciones debern ser apropiadamente atrapadas y relanzadas al componente que invoca. Las excepciones de sistema corresponden a aquellos errores no controlados, diferentes a bugs en el cdigo. Tales como fallas en la conexin en la base de datos, errores causados por invocacin de componentes sin la correcta informacin, haciendo que el sistema en si falle. Las excepciones de negocio, corresponden a todos aquellos errores controlados que ocurren por faltas o violaciones a reglas de negocio codificadas en los componentes, por ejemplo, sobrepaso de topes mximos de transacciones, resultados errneos de bsqueda, validaciones de datos no satisfactorias y otras reglas de negocio especificadas en el sistema. [Descripcin del manejo de las excepciones en el sistema]
19 de 58
1.11 Manejo de Log y seguimiento de procesos Para el seguimiento de errores se establecer un archivo de Log para la aplicacin, basado en la API log4j y configurado para el sistema segn especificaciones internas. El o los archivos de Log sern adecuadamente configurados en la aplicacin para permitir hacer seguimiento a los bugs del sistema para su correccin.
1.12 Configuracin de Log El sistema contar con la capacidad de habilitar y deshabilitar ciertos logs, mientras otros no se afecten. Esto se realiza categorizando los mensajes de logs. [Descripcin de la configuracin de los logs]
1.13 Manejo de auditoria del sistema Cualquier operacin transaccional, es decir, que altere la informacin en la base de datos deber ser registrada en el sistema, para esto se llevar un Log de transacciones. En este Log se almacenar la informacin de la operacin que se ha ejecutado y el responsable de la misma. Este proceso es paralelo a los casos de uso donde se requiere un registro de histrico de transacciones. [Descripcin del proceso del manejo de auditoria]
1.14
Validacin
[Descripcin del proceso de validacin]
20 de 58
1.15 Capa de Acceso a datos [Descripcin del acceso a datos del sistema]
21 de 58
Alternativas De Emergencia (Work-Arounds) [Descripcin de las dificultades de implementacin y alternativas para ser solucionadas]
22 de 58
Librerias y frameworks del Sistema Los frameworks externos e internos utilizados dentro del sistema son: [Descripcin de los frameworks utilizados en el sistema]
23 de 58
ANEXO 1 Glosario [Glosario de terminos manejados en el documento]
24 de 58

Plantilla Documento de Arquitectura

Diunggah oleh

Informasi Dokumen

Hak Cipta

Format Tersedia

Bagikan dokumen Ini

Bagikan atau Tanam Dokumen

Opsi Berbagi

Apakah menurut Anda dokumen ini bermanfaat?

Apakah konten ini tidak pantas?

Hak Cipta:

Format Tersedia

Plantilla Documento de Arquitectura

Diunggah oleh

Hak Cipta:

Format Tersedia

[Empresa contratante]

Arquitectura y Estandares generales para el sistema [Nombre del sistema a desarrollar]

Arquitectura de Sistema Versin 1.1

Versin: [No. versin] [dd/mm/yyyy] Pgina 3

Historial de Revisiones Fecha Versin Descripcin Elabor Aprob

Versin: [No. versin] [dd/mm/yyyy] Pgina 4

Versin: [No. versin] [dd/mm/yyyy] Pgina 5

Definicin de los mdulos del Sistema] [Descripcin del esquema]

Versin: [No. versin] [dd/mm/yyyy] Pgina 11

Definicin de las capas

[Ejemplo del diagrama de Deployment

[Ejemplo del diagrama de las capas fsica y lgica]

Versin: [No. versin] [dd/mm/yyyy] Pgina 12

Diagrama de capas lgicas y fsicas [Descripcin del diagrama ]

[ejemplo del diagrama de componentes]

Versin: [No. versin] [dd/mm/yyyy] Pgina 13

Versin: [No. versin] [dd/mm/yyyy] Pgina 14

Aplicacin [Nombre de la aplicacin]

[Diagrama y Descripcin del comportamiento de la aplicacin ]

Aplicacin de Lgica de Negocio

[Descripcin de la implementacin de la lgica de negocio, patrones a utilizar, descripcin de cada patrn]

Capa de integracin y acceso de datos

[Descripcin de la capa de persistencia]

Versin: [No. versin] [dd/mm/yyyy] Pgina 15

Versin: [No. versin] [dd/mm/yyyy] Pgina 16

Versin: [No. versin] [dd/mm/yyyy] Pgina 17

Versin: [No. versin] [dd/mm/yyyy] Pgina 18

Versin: [No. versin] [dd/mm/yyyy] Pgina 19

Versin: [No. versin] [dd/mm/yyyy] Pgina 20

[Descripcin del proceso de validacin]

Versin: [No. versin] [dd/mm/yyyy] Pgina 21

Versin: [No. versin] [dd/mm/yyyy] Pgina 22

Versin: [No. versin] [dd/mm/yyyy] Pgina 23

Versin: [No. versin] [dd/mm/yyyy] Pgina 24

ANEXO 1 Glosario [Glosario de terminos manejados en el documento]

Anda mungkin juga menyukai