Write diagrams handout

Assets/metadata.yaml

@@ -2,7 +2,7 @@
 title: "IGDB: Base de datos internacional de glaciares"
 subtitle: "Diseño y Desarrollo de Sistemas de Información"
 author: [Amin Kasrou Aouam]
-date: "18 Octubre 2019"
+date: 18/10/2019
 logo: /home/coolneng/Pictures/Logos/UGR.png
 lang: es-ES
 toc: true

Design.org

@@ -29,15 +29,19 @@
    CLOSED: [2019-10-08 Tue 18:16]
    - [X] Pandoc citations
    - [X] Bibtex syntax
-** TODO Setup PlantUML integration [0/2] [0%]
+** DONE Setup PlantUML integration [2/2] [100%]
-   - [ ] Org Babel
+   CLOSED: [2019-10-18 Fri 17:58]
-   - [ ] Source code on a different file
+   - [X] Org Babel
+   - [X] Source code on a different file
 ** DONE Improve first handout [3/3] [100%]
    CLOSED: [2019-10-08 Tue 20:45]
    - [X] Data types
    - [X] Non functional requirements
    - [X] Longer description
-** TODO Generate diagrams [0/3] [0%]
+** DONE Generate diagrams [4/5] [80%]
-   - [ ] Data-flow diagrams
+   CLOSED: [2019-11-01 Fri 00:34]
-   - [ ] Conceptual diagram
+   - [X] Data-flow 
-   - [ ] Functional diagram
+   - [ ] Conceptual 
+   - [X] Functional 
+   - [X] Black box
+   - [X] Entity-Relationship

Docs/Project.md

@@ -36,20 +36,17 @@ Requisitos
     -   Nombre del glaciar - *Cadena de 30 caracteres máximo*
     -   ID del glaciar (Compatible con la WGMS) - *Entero de 5 dígitos*
 2.  **RD2**: Datos anuales de un glaciar
-    -   País - *Cadena de 30 caracteres máximo*
-    -   Nombre del glaciar - *Cadena de 30 caracteres máximo*
     -   ID del glaciar (Compatible con la WGMS) - *Entero de 5 dígitos*
     -   Área - *Entero de 10 dígitos*
     -   Volumen - *Entero de 10 dígitos*
     -   Grosor - *Entero de 10 dígitos*
     -   Año - *Entero de 10 dígitos*
 3.  **RD3**: Datos de cambio de un glaciar
-    -   País - *Cadena de 30 caracteres máximo*
-    -   Nombre del glaciar - *Cadena de 30 caracteres máximo*
     -   ID del glaciar (Compatible con la WGMS) - *Entero de 5 dígitos*
     -   Variación de área - *Entero de 10 dígitos*
     -   Variación de volumen - *Entero de 10 dígitos*
     -   Variación de grosor - *Entero de 10 dígitos*
+    -   Año - *Entero de 10 dígitos*
 4.  **RD4**: Datos del administrador
     -   ID - *Entero de 4 dígitos*
     -   Fecha de alta - *Fecha en formato dd-mm-yyyy*
@@ -135,5 +132,40 @@ Requisitos
 3.  **RS3**: El atributo año solo podrá estar comprendido entre
     2010-2018, inclusive
 
+Diagramas
+---------
+
+Para el diseño del sistema, procederemos con la modelización de
+diagramas estandarizados, dado que es una herramienta imprescindible en
+Ingeniería del Software.
+
+### Diagrama funcional
+
+![](./FD.png)
+
+### Diagramas de flujo
+
+![](./DF1.png)
+
+![](./DF2.png)
+
+![](./DF3.png)
+
+![](./DF4.png)
+
+![](./DF5.png)
+
+![](./DF6.png)
+
+### Diagrama de caja negra
+
+![IGDB](./BB.png)
+
+### Diagrama Entidad-Relación
+
+\newpage
+
+![](./ER.png)
+
 Bibliografía
 ------------

Docs/Project.org

@@ -23,8 +23,6 @@
        - ID del glaciar (Compatible con la WGMS) - /Entero de 5 dígitos/
 
     2. *RD2*: Datos anuales de un glaciar
-       - País - /Cadena de 30 caracteres máximo/
-       - Nombre del glaciar - /Cadena de 30 caracteres máximo/
        - ID del glaciar (Compatible con la WGMS) - /Entero de 5 dígitos/
        - Área - /Entero de 10 dígitos/
        - Volumen - /Entero de 10 dígitos/
@@ -32,12 +30,11 @@
        - Año - /Entero de 10 dígitos/
         
     3. *RD3*: Datos de cambio de un glaciar
-       - País - /Cadena de 30 caracteres máximo/
-       - Nombre del glaciar - /Cadena de 30 caracteres máximo/
        - ID del glaciar (Compatible con la WGMS) - /Entero de 5 dígitos/
        - Variación de área - /Entero de 10 dígitos/
        - Variación de volumen - /Entero de 10 dígitos/
        - Variación de grosor - /Entero de 10 dígitos/
+       - Año - /Entero de 10 dígitos/
     
     4. *RD4*: Datos del administrador
        - ID - /Entero de 4 dígitos/
@@ -112,4 +109,37 @@
     3. *RS3*:
        El atributo año solo podrá estar comprendido entre 2010-2018, inclusive
  
+** Diagramas
+
+   Para el diseño del sistema, procederemos con la modelización de diagramas estandarizados, dado que es una herramienta imprescindible en
+   Ingeniería del Software.
+   
+*** Diagrama funcional  
+
+    [[./FD.png]]
+
+*** Diagramas de flujo  
+    
+    [[./DF1.png]]
+
+    [[./DF2.png]]
+    
+    [[./DF3.png]]
+    
+    [[./DF4.png]]
+    
+    [[./DF5.png]]
+    
+    [[./DF6.png]]
+
+*** Diagrama de caja negra  
+    
+    #+CAPTION: IGDB
+    [[./BB.png]]
+    
+*** Diagrama Entidad-Relación  
+    \newpage
+
+    [[./ER.png]]
+
 ** Bibliografía

Docs/UML.org

@@ -0,0 +1,162 @@
+* Diagramas UML
+
+** Functional
+   
+   #+begin_src plantuml :file ../Assets/Diagrams/FD.png
+     :Script|
+       split
+     :Alta de un glaciar;
+     split again
+     :Inclusión de datos anuales;
+     split again
+     :Cálculo de las variaciones anuales;
+     split again
+     :Actualización de la base de datos;
+     split again
+    :Alta del administrador;
+    :Administrador|
+    :Resolución de conflictos;
+      endsplit
+     :IGDB|
+   #+end_src 
+
+   #+RESULTS:
+   [[file:../Assets/Diagrams/FD.png]]
+
+
+** Data-flow
+
+   #+begin_src plantuml :file ../Assets/Diagrams/DF1.png
+     :Script|
+     :Alta del Glaciar;
+     -> Nuevo glaciar;
+     :Glaciar<
+     :IGDB|
+   #+end_src 
+
+   #+RESULTS:
+   [[file:../Assets/Diagrams/DF1.png]]
+
+   #+begin_src plantuml :file ../Assets/Diagrams/DF2.png
+     :Script|
+     :Inclusión de datos anuales;
+     -> Añadir información;
+     :Glaciar<
+     :IGDB|
+   #+end_src 
+
+   #+RESULTS:
+   [[file:../Assets/Diagrams/DF2.png]]
+
+   #+begin_src plantuml :file ../Assets/Diagrams/DF3.png
+     :Script|
+     :Cálculo de las variaciones anuales;
+     :Inclusión de datos anuales;
+     -> Añadir información;
+     :Glaciar<
+     :IGDB|
+   #+end_src 
+
+   #+RESULTS:
+   [[file:../Assets/Diagrams/DF3.png]]
+
+   #+begin_src plantuml :file ../Assets/Diagrams/DF4.png
+     :Script|
+     :Alta del administrador;
+     -> Nuevo administrador;
+     :Administrador<
+     :IGDB|
+   #+end_src 
+
+   #+RESULTS:
+   [[file:../Assets/Diagrams/DF4.png]]
+
+   #+begin_src plantuml :file ../Assets/Diagrams/DF5.png
+     :Script|
+     :Actualización de la base de datos;
+     :Inclusión de datos anuales;
+     -> Añadir información;
+     :Glaciar<
+     :IGDB|
+   #+end_src 
+
+   #+RESULTS:
+   [[file:../Assets/Diagrams/DF5.png]]
+
+   #+begin_src plantuml :file ../Assets/Diagrams/DF6.png
+     :Script|
+     :Administrador<
+     :Resolución de conflictos;
+     -> Selecciona los datos correctos;
+     :Actualización de la base de datos;
+     :IGDB|
+   #+end_src 
+
+   #+RESULTS:
+   [[file:../Assets/Diagrams/DF6.png]]
+
+** Black box
+
+   #+begin_src plantuml :file ../Assets/Diagrams/BB.png
+     @startuml
+     start
+     :WGMS|
+     :**Sistema**;
+     :IGDB|
+     end
+     @enduml
+   #+end_src 
+
+   #+RESULTS:
+   [[file:../Assets/Diagrams/BB.png]]
+
+** Entity Relationship
+
+
+   #+begin_src plantuml :file ../Assets/Diagrams/ER.png
+     @startuml
+     hide circle
+     skinparam linetype ortho
+     entity "Glacier" as e01 {
+       ,* **glacier_id** : number <<generated>>
+       --
+       ,*glacier_name : text
+       --
+       ,*glacier_country: text
+     }
+     entity "Glacier yearly data" as e02 {
+       ,* **glacier_id** : number <<FK>>
+       --
+       ,*glacier_volume: number
+       --
+       ,*glacier_area: number
+       --
+       ,*glacier_thickness: number
+       --
+       ,*glacier_year: number
+     }
+     entity "Glacier yearly fluctuation" as e03 {
+       ,* **glacier_id** : number <<FK>>
+       --
+       ,*glacier_area_change: number
+       --
+       ,*glacier_volume_change: number
+       --
+       ,*glacier_thickness_change: number
+       --
+       ,*glacier_year: number <<FK>>
+     }
+     entity "Admin" as e04 {
+       ,*admin_id : number <<generated>>
+       --
+       ,*admin_creation_date: date
+     }
+     e01 ||..|{ e02
+     e02 ||..|| e03
+     e01 ||..|{ e03
+     e04 ||..o| e01
+     @enduml
+   #+end_src 
+
+   #+RESULTS:
+   [[file:../Assets/Diagrams/ER.png]]

Makefile

@@ -30,6 +30,7 @@ OPTIONS                += --metadata-file=$(META)
 OPTIONS                += -M bibliography=$(BIBFILE)
 OPTIONS                += --listings
 OPTIONS                += --include-in-header=$(TMP)
+OPTIONS                += --resource-path=./Assets/Diagrams
 
 
 ## Template variables